> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.
# 取引取得API：KYT取引の詳細
> DiditのKYT取引を取得します。関連当事者、支払い方法、アラート、ルール一致、トラベルルールチェック、是正リンク、ネットワークのスナップショットを確認できます。
取引取得APIのプロンプト
プロンプトをクリップボードにコピー
\
\`Fetch the full detail of a Didit monitored transaction through the Management API.
Endpoint:
GET https://verification.didit.me/v3/transactions/{transaction_id}/
Authentication:
Use the x-api-key header with my Didit API key.
Goal:
\- Retrieve every detail of a transaction — linked parties, payment methods, alerts, rule matches, travel-rule checks, remediation links, network snapshots, cost breakdown — so I can render a detail screen or feed a downstream decision.
Path parameter:
\- transaction_id - Didit's transaction uuid (the uuid returned by POST /v3/transactions/).
Your own txn_id is not accepted here and returns 404.
Example call:
curl -X GET "https://verification.didit.me/v3/transactions/{transaction_id}/" \
-H "x-api-key: YOUR_API_KEY"
What to read from the response:
\- uuid, transaction_number, txn_id — identifiers.
\- status, score, severity, decision_reason_code, decision_reason_label — current verdict.
\- direction, amount, currency, currency_type, action_type, payment_details, payment_txn_id - the submitted details as top-level fields (there is no transaction_details object, and currency_type carries the currency_kind you sent).
\- parties - party records with role APPLICANT (the subject) or COUNTERPARTY (the other side) and kind USER, BUSINESS or EXTERNAL, each with entity_type, vendor_data, full_name, address and device.
\- payment_methods - the linked payment methods, each with payment_method_type, account_id and role (for example SOURCE or DESTINATION).
\- cost_breakdown — provider-by-provider cost detail for this transaction.
\- rule_runs / alerts — which rules fired and their outcomes.
\- provider_results - crypto screening (blockchain analytics) results, when a screening ran.
\- travel_rule - the Travel Rule transfer (uuid, status, protocol, required, obligations_count, originator_data, beneficiary_data, metadata, direction, rail, counterparty_vasp, delivery, discovery, reason, next_actions), or null when the transaction has none.
For a COUNTERPARTY_VASP_NOT_FOUND or COUNTERPARTY_VASP_NOT_REACHABLE transfer, reason says why it is stuck and next_actions what moves it on: email_undeliverable offers update_compliance_email then resend, delivery_failed offers resend, and a discovery reason (awaiting_end_user, directory_match_no_route, picked_member_without_proven_wallet, no_directory_match) offers select_counterparty_vasp, declare_self_hosted, add_vasp_hint and resend.
delivery is the newest message the transfer owes the other side (kind, status, rail, attempts, last_error, next_attempt_at, delivered_at), or null; discovery is the trace of where Didit looked for the counterparty.
On an inbound transfer, the counterparty's originator_data and beneficiary_data stay masked (data_masked: true) until wallet ownership is confirmed.
\- tags — Console tags (uuid, name, color).
\- assigned_to_name (the Console reviewer) is not part of this response; the list endpoint GET /v3/transactions/ returns it.
Use cases:
\- Render the Console-equivalent "Transaction detail" screen in your back-office.
\- Reconcile rule outcomes against your own ledger.
\- Poll after a transaction.status.updated webhook to fetch the fresh verdict.
Failure modes:
\- 403 - missing x-api-key (a wrong, revoked or expired key gets 401), or a key without permission for this action ({ "detail": "..." } envelope).
\- 404 - transaction not found in this application, including a transaction that belongs to another application (or deleted via the Console).
\- 429 — rate limited; back off and retry.
Side effects: none. This is a pure read.
For the full integration shape, see /integration/integration-prompt.`
\
貼り付け先
## OpenAPI
````yaml ja/openapi-25.json GET /v3/transactions/{transaction_id}/
openapi: 3.0.0
info:
version: 3.0.0
title: Didit Verification API
description: 本人確認API。x-api-keyヘッダーで認証します。
servers:
- url: https://verification.didit.me
security: []
tags: []
paths:
/v3/transactions/{transaction_id}/:
get:
tags:
- Transactions
summary: 取引を取得
description: >-
1件の取引の完全なモニタリング記録を取得します。当事者、スコア/重大度、ルールの実行結果、アラート、トラベルルールの結果、是正セッションが含まれます。
operationId: getTransaction
parameters:
- name: transaction_id
in: path
required: true
description: Diditの安定した取引UUIDです（作成または一覧取得で返される`uuid`であり、`txn_id`**ではありません**）。
schema:
type: string
format: uuid
example: abcdef12-3456-7890-abcd-ef1234567890
responses:
'200':
description: 取引の完全な詳細。
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionDetail'
examples:
In review with an alert:
value:
uuid: abcdef12-3456-4890-abcd-ef1234567890
environment: live
transaction_number: 4123
txn_id: your-txn-2026-05-17-001
txn_date: '2026-05-17T08:42:00Z'
zone_id: Europe/Madrid
transaction_type: finance
action_type: withdrawal
direction: OUTBOUND
status: IN_REVIEW
source: LIVE
amount: '1500'
currency: EUR
currency_type: fiat
amount_in_default_currency: '1620.45'
default_currency_code: USD
preferred_currency_amount: '1620.45'
preferred_currency_code: USD
payment_details: Withdrawal to crypto wallet
payment_txn_id: null
score: 78
severity: HIGH
decision_reason_code: WALLET_HIGH_RISK
decision_reason_label: Destination wallet flagged as high risk
vendor_data: user-12345
metadata:
subject:
entity_type: individual
vendor_data: user-12345
full_name: Maria Garcia
address: {}
institution_details: {}
device_context: {}
counterparty: {}
props:
order_id: ord-9988
tags: []
parties:
- uuid: b1111111-2222-4333-8444-555555555555
role: APPLICANT
entity_type: individual
kind: USER
vendor_data: user-12345
full_name: Maria Garcia
first_name: null
last_name: null
country_code: null
dob: null
address: {}
institution_info: {}
device: {}
external_party_snapshot: null
payment_methods: []
documents: []
activities: []
alerts:
- uuid: a7b8c9d0-1234-4abc-9def-567890abcdef
title: Destination wallet flagged as high risk
description: Provider risk score exceeded the configured threshold.
severity: HIGH
status: OPEN
source: RULE
metadata: {}
created_at: '2026-05-17T08:42:12Z'
due_at: null
rule_runs: []
provider_results: []
travel_rule: null
network_snapshot: null
remediation: null
action_required: null
cost_breakdown: null
'403':
description: >-
APIキーがない、無効、または失効しているか、このアプリケーションの取引を読み取る権限がキーにありません。キーがない場合は`403`を返し、誤った、失効した、または期限切れのキーの場合は`401`を返します。
content:
application/json:
examples:
Forbidden:
value:
detail: You do not have permission to perform this action.
'404':
description: >-
このUUIDの取引がアプリケーションに存在しません(削除済み、未作成、別のアプリケーションに属している、またはパスセグメントが有効なUUIDではない)。
content:
application/json:
examples:
Not found:
value:
detail: Not found.
'429':
description: レート制限を超過しました。間隔を空け、`Retry-After`で示された時間が経過してから再試行してください。
content:
application/json:
examples:
Throttled:
value:
detail: Request was throttled. Expected available in 30 seconds.
security:
- ApiKeyAuth: []
x-codeSamples:
- lang: curl
label: curl
source: >-
curl -X GET
'https://verification.didit.me/v3/transactions/abcdef12-3456-7890-abcd-ef1234567890/'
\
-H 'x-api-key: YOUR_API_KEY'
- lang: python
label: Python
source: |-
from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.transactions.retrieve(
"abcdef12-3456-7890-abcd-ef1234567890",
)
print(result)
- lang: javascript
label: Node.js
source: >-
import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await
didit.transactions.retrieve("abcdef12-3456-7890-abcd-ef1234567890");
console.log(result);
- lang: go
label: Go
source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Transactions.Retrieve(ctx, \"abcdef12-3456-7890-abcd-ef1234567890\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
- lang: java
label: Java
source: >-
import me.didit.Didit;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result =
client.transactions().retrieve("abcdef12-3456-7890-abcd-ef1234567890");
System.out.println(result);
- lang: php
label: PHP
source: >-
transactions->retrieve('abcdef12-3456-7890-abcd-ef1234567890');
print_r($result->toArray());
- lang: ruby
label: Ruby
source: >-
require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result =
didit.transactions.retrieve("abcdef12-3456-7890-abcd-ef1234567890")
puts result.to_h
- lang: csharp
label: .NET
source: >-
using System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await
client.Transactions.RetrieveAsync("abcdef12-3456-7890-abcd-ef1234567890");
Console.WriteLine(JsonSerializer.Serialize(result));
components:
schemas:
TransactionDetail:
type: object
description: >-
1件の取引に関する完全なモニタリング記録。`GET /v3/transactions/{transaction_id}/`および`POST
/v3/transactions/`から返されます。
properties:
uuid:
type: string
format: uuid
description: Diditの安定した取引識別子です。後続の呼び出しで`{transaction_id}`として使用します。
environment:
type: string
enum:
- live
- sandbox
description: >-
取引を所有するアプリケーションの環境。`sandbox`の取引は保存されますが、評価、スクリーニング、通知、請求は一切行われません。そのため、空の`rule_runs`は「未評価」を意味します。
transaction_number:
type: integer
description: 'Consoleに表示される、アプリケーション単位の取引の連番（例: `4123`）。'
txn_id:
type: string
description: 作成時に指定した`transaction_id`（最大128文字）。アプリケーションごとに一意です。
txn_date:
type: string
format: date-time
description: 取引が発生した日時（`transaction_at`の値。デフォルトは送信日時）。
zone_id:
type: string
nullable: true
description: 作成時に指定されたIANAタイムゾーン識別子。
transaction_type:
type: string
description: >-
保存されている最上位カテゴリー:
`finance`、`kyc`、`travelRule`、`userPlatformEvent`、`gamblingBet`、`gamblingLimitChange`、`gamblingBonusChange`、`auditTrailEvent`。複数語の値は、snake_caseで送信した場合でもcamelCaseで返される点に注意してください。
action_type:
type: string
description: >-
カテゴリ内のサブタイプ（例:
`deposit`、`withdrawal`、`transfer`）。指定しない場合はカテゴリがデフォルトになります。
direction:
type: string
enum:
- INBOUND
- OUTBOUND
description: >-
対象者から見た方向です。送信時の大文字・小文字にかかわらず大文字で保存されます（入力では`in`/`out`/`inbound`/`outbound`を受け付けます）。
status:
type: string
enum:
- APPROVED
- IN_REVIEW
- DECLINED
- AWAITING_USER
description: >-
現在のモニタリング判定。取引は`APPROVED`で作成され、ルールによって同期的に`IN_REVIEW`/`DECLINED`に変更される場合があります。
source:
type: string
enum:
- LIVE
- IMPORTED
description: レコードの発生元：APIまたはSDKで送信された取引は`LIVE`、コンソールのインポートで読み込まれた取引は`IMPORTED`。
amount:
type: string
description: >-
末尾のゼロを除去した10進数文字列で表した取引金額（例:
`"1500"`、`"0.5"`、`"0.123456789012345678"`）。小数点以下最大18桁です。
currency:
type: string
description: >-
`amount`の通貨コード。ISO 4217の任意のアルファベットコード（例:
`EUR`、`USD`、`NGN`）と暗号資産シンボル（例:
`BTC`）を受け付けます。現在流通しているコードを推奨します。受け付けられるすべてのコードに為替レートがあるわけではありません。コードに為替レートがない場合（たとえばISOの会計単位`XSU`や、Diditが価格を付けていない暗号資産シンボル）、自動換算は失敗し、リクエストで換算済みの`amount_in_default_currency`を指定していない限り`preferred_currency_amount`はnullで返されます。
currency_type:
type: string
nullable: true
description: '`currency_kind`で送信されたとおりの`fiat`または`crypto`。'
amount_in_default_currency:
type: string
nullable: true
description: 指定された事前換算済みの金額。末尾のゼロを除いた10進数の文字列です。
default_currency_code:
type: string
nullable: true
preferred_currency_amount:
type: string
nullable: true
description: 利用可能な場合に、アプリケーションの優先通貨に換算した`amount`です。
preferred_currency_code:
type: string
nullable: true
payment_details:
type: string
nullable: true
description: 送信内容に含まれる自由記述の支払い参照情報またはメモ。
payment_txn_id:
type: string
nullable: true
description: '`payment_reference_id`から取得した外部決済システムの参照番号です（例: ブロックチェーンの取引ハッシュ）。'
score:
type: integer
description: ルールによって累積されたリスクスコア(通常0~100)。値が高いほどリスクが高くなります。
severity:
type: string
nullable: true
enum:
- UNKNOWN
- LOW
- MEDIUM
- HIGH
- CRITICAL
description: >-
ルールまたはプロバイダーが設定するカテゴリ別のリスク重大度（`UNKNOWN`、`LOW`、`MEDIUM`、`HIGH`、`CRITICAL`）。いずれかによって設定されるまでは`null`です。
decision_reason_code:
type: string
nullable: true
description: 現在の`status`の機械可読な理由。
decision_reason_label:
type: string
nullable: true
description: '`decision_reason_code`の人が読めるラベル。'
vendor_data:
type: string
nullable: true
description: 申請者の`vendor_data`の便宜上のコピー。
metadata:
type: object
description: 作成時に送信された`subject`および`counterparty`ペイロードのスナップショット。
props:
type: object
description: >-
作成時に指定した`custom_properties`です。各キーはルールの条件内で`custom_values.`として参照できます。
tags:
type: array
items:
type: object
properties:
uuid:
type: string
format: uuid
name:
type: string
color:
type: string
description:
type: string
nullable: true
source:
type: string
enum:
- didit
- custom
description: タグがDiditのプリセットかカスタムタグか。
description: 取引に付与されたタグ(手動またはルールによる)。
parties:
type: array
items:
type: object
properties:
uuid:
type: string
format: uuid
role:
type: string
enum:
- APPLICANT
- REMITTER
- BENEFICIARY
- COUNTERPARTY
description: 関係者の役割。作成エンドポイントは`APPLICANT`（対象者）と`COUNTERPARTY`を割り当てます。
entity_type:
type: string
enum:
- individual
- company
- external
- unhostedWallet
kind:
type: string
enum:
- USER
- BUSINESS
- EXTERNAL
description: >-
`USER`/`BUSINESS`の当事者は、`vendor_data`を介してDiditが所有するエンティティに紐付きます。`EXTERNAL`の当事者には、背後にDiditのエンティティがありません。
vendor_data:
type: string
nullable: true
description: お客様の内部ユーザー/企業識別子です。
full_name:
type: string
nullable: true
first_name:
type: string
nullable: true
last_name:
type: string
nullable: true
country_code:
type: string
nullable: true
description: 送信された`address.country`から取得した国コード(通常はISO 3166-1 alpha-3)。
dob:
type: string
format: date
nullable: true
description: 送信された`date_of_birth`の生年月日。
address:
type: object
description: 送信されたとおりの住所オブジェクト。省略された場合は`{}`です。
institution_info:
type: object
description: 送信されたとおりの機関の詳細。省略した場合は`{}`です。
device:
type: object
description: >-
正規化されたデバイスコンテキスト。IPが指定された場合は、network_context配下にサーバー側のIPエンリッチメント（位置情報、VPN/データセンターのフラグ）が含まれます。
properties:
fingerprint:
type: string
description: 一意のデバイスフィンガープリント。
persistent_device_id:
type: string
description: セッションをまたいで不変のデバイス識別子(v2フィンガープリントスキーマ)。
user_agent:
type: string
description: ブラウザまたはアプリのユーザーエージェント文字列。
browser_family:
type: string
description: ブラウザーファミリー（例：Chrome、Firefox、Safari）。
browser_version:
type: string
description: ブラウザのバージョン文字列。
platform:
type: string
description: プラットフォーム識別子(web、ios、android、macos、windows、linux)。
os_family:
type: string
description: 'オペレーティングシステムのファミリー（例: iOS、Android、Windows）。'
os_version:
type: string
description: オペレーティングシステムのバージョン文字列です。
accept_language:
type: string
description: Accept-Languageヘッダーの値。
session_id:
type: string
description: セッション識別子（メタデータに保存）。
session_age_ms:
type: number
description: セッションの経過時間（ミリ秒）。
network_context:
type: object
description: IPアドレスと位置情報を含むネットワークコンテキスト。
properties:
ip_address:
type: string
description: クライアントのIPアドレス。
ip_country_code:
type: string
description: IPアドレスの位置情報から特定された国（ISO 3166-1 alpha-3）。
latitude:
type: number
description: IPの地理的な緯度。
longitude:
type: number
description: IPの地理的な経度。
external_party_snapshot:
type: object
nullable: true
description: >-
`EXTERNAL`当事者の当事者データの固定コピー。当事者がDiditのユーザーまたは企業にリンクされている間は`null`です。
description: 取引の当事者（申請者、取引相手）。
payment_methods:
type: array
items:
type: object
properties:
uuid:
type: string
format: uuid
payment_method_type:
type: string
enum:
- bank_card
- bank_account
- e_wallet
- crypto_wallet
- unhosted_wallet
- other
label:
type: string
nullable: true
fingerprint:
type: string
nullable: true
description: >-
`type:account_id:issuing_country`に対するSHA-256。同一の手段の再利用を関連付けるための安定した識別子です。
account_id:
type: string
nullable: true
description: 口座識別子（IBAN、ウォレットアドレス、カードトークンなど）。
issuing_country:
type: string
nullable: true
owner_kind:
type: string
enum:
- USER
- BUSINESS
- EXTERNAL
vendor_data:
type: string
nullable: true
description: 所有するユーザー/企業に対するお客様の識別子です。
owner_name:
type: string
nullable: true
institution_info:
type: object
details:
type: object
description: 送信されたままの生の`payment_method`オブジェクト。
external_owner_snapshot:
type: object
nullable: true
role:
type: string
enum:
- SOURCE
- DESTINATION
- FUNDING
- BENEFICIARY
description: >-
この手段が取引でどのように使われたか。作成エンドポイントは方向に基づいて`SOURCE`/`DESTINATION`を割り当てます（送信：対象者
= SOURCE、受信：対象者 = DESTINATION）。
description: 取引に紐づく支払い方法。
documents:
type: array
description: コンソールから取引に添付されたファイル。ない場合は`[]`です。
items:
type: object
properties:
uuid:
type: string
format: uuid
label:
type: string
nullable: true
note:
type: string
nullable: true
uploaded_by:
type: string
nullable: true
created_at:
type: string
format: date-time
files:
type: array
items:
type: object
properties:
uuid:
type: string
format: uuid
file_url:
type: string
format: uri
nullable: true
description: 有効期間の短い署名付きダウンロードURL。保存せず、必要なときに取得してください。
original_filename:
type: string
nullable: true
file_size:
type: integer
nullable: true
activities:
type: array
items:
type: object
properties:
uuid:
type: string
format: uuid
activity_type:
type: string
description: >-
例：`TRANSACTION_CREATED`、`TRANSACTION_NOTE_ADDED`、`TRANSACTION_STATUS_CHANGED`。
source:
type: string
status:
type: string
nullable: true
title:
type: string
nullable: true
description:
type: string
nullable: true
metadata:
type: object
occurred_at:
type: string
format: date-time
description: アクティビティログのエントリ（作成、メモ、手動レビュー、ステータスの変更）。
alerts:
type: array
items:
type: object
properties:
uuid:
type: string
format: uuid
title:
type: string
description:
type: string
nullable: true
severity:
type: string
enum:
- UNKNOWN
- LOW
- MEDIUM
- HIGH
- CRITICAL
status:
type: string
enum:
- OPEN
- INVESTIGATING
- AWAITING_USER
- PENDING_SAR
- SAR_FILED
- RESOLVED
- DISMISSED
source:
type: string
enum:
- RULE
- PROVIDER
- MANUAL
metadata:
type: object
created_at:
type: string
format: date-time
due_at:
type: string
format: date-time
nullable: true
description: 現在は常に空です。未対応のアラートとは、ステータスが`IN_REVIEW`または`AWAITING_USER`の取引です。
rule_runs:
type: array
items:
type: object
properties:
uuid:
type: string
format: uuid
rule:
type: string
format: uuid
description: 実行されたルールのUUID。
rule_title:
type: string
rule_description:
type: string
nullable: true
rule_category:
type: string
matched:
type: boolean
description: >-
ルールの条件がこの取引に一致したかどうか。実行記録は一致したルールについてのみ残るため、本番の評価では常に`true`になります。
is_test:
type: boolean
description: ルールがTESTモードで実行された場合はtrue（ステータス/スコアには影響しません）。
mode:
type: string
enum:
- ACTIVE
- DISABLED
- TEST
severity:
type: string
nullable: true
score_delta:
type: integer
description: このルールの`add_score`アクションによって加算されたスコア。
status_target:
type: string
nullable: true
description: '`change_status`アクションで設定されたステータス（設定された場合）。'
action_summary:
type: string
nullable: true
description: >-
ルールが実行したアクションの概要で、`; `で連結されます（例：`score +30;
change_status:IN_REVIEW;
add_tag:high_risk_country`）。構成要素：`score
+N`、`change_status:`、`add_tag:`、`add_note`、`add_to_list`、`open_case`。ルールがアクションを実行しなかった場合は`null`です。
metadata:
type: object
description: >-
評価の詳細:`scope_match`、`conditions[]`、`aggregations[]`。各条件エントリには、`field`、`operator`、`expected_value`、取引から読み取った`current_value`、`matched`、`group_index`、`group_logic`が含まれます。各集計エントリ(velocity
/ count /
sum)には、`metric`、`field`、`operator`、`expected_value`、集計の評価結果である`computed_value`、`window`、`filters`、`matched`、`sample_references`が含まれます。遅延された非同期集計では`computed_value:
null`および`deferred:
true`となります。ネストされた条件グループは、`operator`が`any_of`または`all_of`で`field`がnullの1つの`conditions[]`エントリであり、メンバーの結果はそのエントリ自身の`conditions`の下に格納されます。
created_at:
type: string
format: date-time
description: ルールごとの実行結果です。どのルールが発動し、スコアにどのような影響を与えたかを示します。
provider_results:
type: array
items:
type: object
properties:
uuid:
type: string
format: uuid
provider:
type: string
result_type:
type: string
enum:
- FIAT_MONITORING
- WALLET_SCREENING
- TRANSACTION_SCREENING
- TRAVEL_RULE
- NETWORK_GRAPH
- CUSTOM
status:
type: string
severity:
type: string
nullable: true
score:
type: integer
summary:
type: string
nullable: true
payload:
type: object
description: プロバイダーの生のレスポンスペイロード。
created_at:
type: string
format: date-time
description: プロバイダーの生のペイロード（AMLスクリーニング、ブロックチェーン分析など）。
travel_rule:
nullable: true
allOf:
- $ref: '#/components/schemas/TransactionTravelRule'
description: >-
トラベルルールの送金またはチェック。`travel_rule_details`が送信された場合に設定されるほか、トラベルルールが有効で、取引が`transaction_category:
travelRule`で作成された場合にも設定されます（`travel_rule_details`がなくても、Didit自身が交換を開始します）。送金やチェックが存在しない場合は`null`です。インバウンド送金では、ウォレットの所有権が確認されるまで、取引相手の`originator_data`と`beneficiary_data`はマスクされたまま（`data_masked:
true`）になります。
network_snapshot:
type: object
nullable: true
description: >-
ルールエンジンが使用する、関連する取引と当事者のグラフスナップショット。取引とともに送信された`network_snapshot`、またはAMLウォレットスクリーニングが成功した際にDiditが構築するグラフ(送信されたものを置き換えます)のいずれかです。どちらも存在しない場合は`null`です。
properties:
uuid:
type: string
format: uuid
nodes:
type: array
items:
type: object
edges:
type: array
items:
type: object
metrics:
type: object
remediation:
type: object
nullable: true
description: >-
再検証が必要な場合にユーザーに提示される是正用のセッションです。正規のブロックである`action_required`に置き換えられました。後方互換性のために残されています。
properties:
session_id:
type: string
session_token:
type: string
url:
type: string
format: uri
status:
type: string
action_required:
type: object
nullable: true
description: >-
この取引を完了するために必要な保留中のエンドユーザーアクション。存在しない場合はnull。Didit
SDKはデフォルトでこのアクションを自動的に起動し、完了時に取引を更新します。`type`で区別される2つのバリアントがあります。`verification_session`（ルールのアクションによって作成されたホスト型認証セッション）と`wallet_ownership`（ウォレット管理の証明が必要なトラベルルール送金のために自動発行されるウォレット所有権ウィジェットセッションで、トラベルルール設定の`auto_wallet_verification`によって制御されます）です。両方が該当しうる場合は、トラベルルールの交換をブロックするため`wallet_ownership`が優先されます。
oneOf:
- $ref: '#/components/schemas/TransactionVerificationSessionAction'
- $ref: '#/components/schemas/TransactionWalletOwnershipAction'
discriminator:
propertyName: type
mapping:
verification_session: '#/components/schemas/TransactionVerificationSessionAction'
wallet_ownership: '#/components/schemas/TransactionWalletOwnershipAction'
cost_breakdown:
type: object
nullable: true
description: >-
この取引の費用。`total_price`と`items`で構成され、itemsは請求ごとに1件で、それぞれ`usage_type`、`price`、`details`、`created_at`を含みます。同じ取引を再スクリーニングすると新しい項目になります。
TransactionTravelRule:
type: object
description: >-
取引のトラベルルール送金です。`GET /v3/transactions/{transaction_id}/`、`POST
/v3/transactions/`の`201`、および`GET
/v3/transactions/`の各行で返されます。`direction`、`rail`、`counterparty_vasp`、`delivery`、`discovery`、`reason`、`next_actions`は`PATCH
/v3/transactions/{transaction_id}/travel-rule/`と同じ形式のため、取引を1回読み取るだけで、送金が停滞している理由と、先へ進めるための操作がわかります。
properties:
uuid:
type: string
format: uuid
status:
type: string
protocol:
type: string
nullable: true
required:
type: boolean
obligations_count:
type: integer
originator_data:
type: object
description: 送金人当事者です。受信する送金の場合、取引相手の値は所有権が確認されるまでマスクされます。
beneficiary_data:
type: object
description: 受取人の当事者情報。受信側の送金では、所有権が確認されるまで取引相手の値はマスクされます。
name_match:
type: object
nullable: true
description: 送金の判定を決めた氏名比較(スコアと厳格度)です。比較が実行されるまではnullです。比較された名前は当事者とともにマスクされます。
data_match:
$ref: '#/components/schemas/TravelRuleDataMatch'
mismatched_fields:
type: array
items:
type: string
description: '`data_match.mismatched_fields`のショートカット。相違がない場合は空です。'
data_unmasked:
$ref: '#/components/schemas/TravelRuleDataUnmasked'
data_masked:
type: boolean
description: このレスポンスで取引相手の個人データがマスクされている間はtrueです。
metadata:
type: object
direction:
type: string
enum:
- INBOUND
- OUTBOUND
description: この送金がやり取りのどちら側にあたるか。
rail:
type: string
nullable: true
description: >-
送金に使われたレール:
`INTERNAL`、`TRP`、`GTR`、`TRUST`、`VERIFYVASP`、`SYGNA`または`EMAIL`（サンドボックスのアプリケーションでDidit
Test VASPが応答した場合は`TEST_VASP`）。レールが選択されるまでは`null`です。
counterparty_vasp:
type: object
nullable: true
properties:
name:
type: string
lei:
type: string
dd_score:
type: integer
description: 0から100までのデューデリジェンススコアで、値が高いほど良好です。VASPディレクトリと同じ尺度です。
dd_score_breakdown:
type: object
description: >-
dd_scoreへのコンポーネントごとの寄与。VASPディレクトリと同様に、コンポーネント（jurisdiction、verification、protocol、lei、history、essentials、responsiveness）ごとに1つのオブジェクトがあり、それぞれ{points,
max, reason, detail}を含みます。取引相手が評価されるまでは{}です。
additionalProperties:
type: object
properties:
points:
type: number
description: このコンポーネントに付与されるポイント。
max:
type: integer
description: このコンポーネントが付与できる最大ポイントです。
reason:
type: string
description: コンポーネントの判定を示す機械可読コード。
detail:
type: string
description: 付与されたポイントの理由を示す、人が読める形式の説明。
dd_assessed_at:
type: string
format: date-time
nullable: true
description: デューデリジェンス評価が最後に実行された日時。取引相手が評価されるまではnull。
description: 取引相手のディレクトリエントリ。送金に紐付けられたものがない場合は`null`です。
delivery:
nullable: true
allOf:
- $ref: '#/components/schemas/TravelRuleDelivery'
description: >-
この送金が他の当事者に送信する義務を負う最新のメッセージ。一度も義務が生じていない場合（例:
`threshold_amount`未満の場合や、申告済みのセルフホスト型ウォレットの場合）は`null`です。
discovery:
type: array
description: >-
Diditが取引相手をどのように探索したかを示します。実行されたステップごとに1エントリです。受信送金など、探索が実行されなかった場合は空です。
items:
$ref: '#/components/schemas/TravelRuleDiscoveryStep'
reason:
type: string
description: >-
`COUNTERPARTY_VASP_NOT_FOUND`または`COUNTERPARTY_VASP_NOT_REACHABLE`の送金が停止している理由です。その他のステータスでは`""`です。`COUNTERPARTY_VASP_NOT_REACHABLE`の場合に限り、配信の失敗がまず理由を決定します：`email_undeliverable`（メールプロバイダーがコンプライアンスメールを拒否し、試行できるアドレスが残っていない。送信時、リマインダー時、または後から報告された恒久的なバウンスのいずれか）または`delivery_failed`（配信中のレールが完全に失敗した。ネットワークレールがメッセージを拒否したか再試行回数を使い切った、`TRP`のIDホストが応答しなかった、または取引相手の`TRP`ホストが照会を受け付けなかった）。それ以外の場合は`discovery`トレースが理由を決定します：`awaiting_end_user`（Diditが到達できる取引相手を指定したステップがない）、`directory_match_no_route`（ステップが経路のないディレクトリ上のVASPを指定した）、`picked_member_without_proven_wallet`（エンドユーザーが、ウォレットの管理を証明していないDiditの顧客を選択した）、またはトレースが他の理由を示さない場合は`no_directory_match`です。再送すると送金が先に進むため、理由はクリアされます。[送金が停止する理由](/ja/transaction-monitoring/travel-rule#送金が停止している理由)を参照してください。
next_actions:
type: array
description: >-
送金を先に進めるためのアクションです。`COUNTERPARTY_VASP_NOT_FOUND`または`COUNTERPARTY_VASP_NOT_REACHABLE`以外のステータスでは`[]`です。`email_undeliverable`では`update_compliance_email`、次に`resend`が提示されます。`delivery_failed`では`resend`が提示されます。検出に関する理由では`select_counterparty_vasp`、`declare_self_hosted`、`add_vasp_hint`、`resend`が提示されます。
items:
$ref: '#/components/schemas/TravelRuleNextAction'
chain_details:
$ref: '#/components/schemas/TravelRuleChainDetails'
TransactionVerificationSessionAction:
title: Verification session
type: object
properties:
type:
type: string
enum:
- verification_session
url:
type: string
format: uri
description: エンドユーザー向けに開くホスト型検証URLです。
session_id:
type: string
format: uuid
description: 認証セッションID。
session_token:
type: string
description: セッショントークン。モバイルSDKがフローをネイティブに起動する際に使用します。
status:
type: string
description: 認証セッションのステータス。
required:
- type
- url
TransactionWalletOwnershipAction:
title: Wallet ownership
type: object
properties:
type:
type: string
enum:
- wallet_ownership
url:
type: string
format: uri
description: >-
ホスト型ウォレット所有権ウィジェットのURLです。実際のブラウザ画面で開いてください。モバイルではSFSafariViewControllerまたはChrome
Custom Tabを使用し、埋め込みWebViewは決して使用しないでください。
widget_session_id:
type: string
format: uuid
description: ウォレット所有権ウィジェットのセッションID。
expires_at:
type: string
format: date-time
description: ウィジェットセッションの有効期限。
required:
- type
- url
TravelRuleDataMatch:
type: object
nullable: true
description: >-
送金の当事者データと、相手側がウォレット保有者について把握している情報とのフィールドごとの比較。フィールド名と結果のみを示し、値は一切含まないため、取引相手のデータがマスクされている間も読み取ることができます。比較が実行されるまではnullです。
properties:
matched:
type: boolean
description: 比較したフィールドに差異がない場合はtrue。
mismatched_fields:
type: array
items:
type: string
enum:
- name
- date_of_birth
- address
- account
description: 差異のあるフィールドです。
fields:
type: object
description: >-
当事者のエンティティ種別について比較されたフィールドごとに1エントリー（`name`、`date_of_birth`、`address`、`account`。企業には`date_of_birth`はありません）。
additionalProperties:
type: object
properties:
result:
type: string
enum:
- matched
- mismatched
- not_compared
description: ルールが`NONE`の場合、またはいずれかの側にそのフィールドの値がない場合は`not_compared`。
strictness:
type: string
enum:
- NONE
- STRICT
- CONTAINS
- DEFAULT
- FUZZY
TravelRuleDataUnmasked:
type: object
nullable: true
description: 取引相手のデータのマスクが解除された時点の監査記録です。データがまだマスクされている間、および外部への送金の場合はnullです。
properties:
at:
type: string
format: date-time
reason:
type: string
enum:
- ownership_confirmed
- wallet_proof
- address_book_match
- own_verified_wallet
- inquiry_approved
- known_payment_method
- travel_address
description: >-
所有を確認した根拠:
ownership_confirmed（コンソールまたはAPIを通じたお客様による確認）、wallet_proof（ウィジェットでのウォレット証明、またはINTERNALの受信送金。作成時に設定されます）、address_book_match（検証済みのアドレス帳ウォレット）、own_verified_wallet（ユーザー自身の検証済みウォレット）、inquiry_approved（受信したTRP照会、またはGTRもしくはSygnaメッセージをお客様が承認したこと）、known_payment_method（ユーザーがすでに支払いに使用したウォレット）、travel_address（ウォレットごとのトラベルアドレスがそのウォレットを指定したこと）のいずれかです。
actor:
type: string
description: 確認した主体：コンソールユーザーのメールアドレス、またはAPIキーのラベル。自動判定の場合は空欄です。
TravelRuleDelivery:
type: object
description: >-
移転が相手側に送るべき最新メッセージの状況です。Diditは、移転を作成または変更したリクエストがレスポンスを返した後に取引相手に連絡するため、このオブジェクトはそのメッセージが届いたかどうかを示します。キュー待ち、送信中、エラー後の再試行待ち、配信済み、または失敗のいずれかです。ネットワークが回復する可能性のある失敗（時間内に応答がない、接続の失敗、HTTP
`408`、`429`、`5xx`）は、30秒後、2分後、10分後、30分後、1時間後に再試行されます。最初のメッセージ（`kind:
SEND`）が、ネットワークに拒否された、または6回目の試行も失敗したために最終的に失敗した場合、移転は`COUNTERPARTY_VASP_NOT_REACHABLE`に移行し、その`timeline`に`last_error`が記録されます。それ以外のメッセージが最終的に失敗した場合は、`timeline`に記録されます。やり取りそのものについては、引き続き移転の`status`が信頼できる情報源です。
required:
- kind
- status
- rail
- attempts
- last_error
- next_attempt_at
- delivered_at
properties:
kind:
type: string
enum:
- SEND
- ANSWER
- TXID
- CANCEL
- POLL
description: >-
メッセージが運ぶ内容です。`SEND`:
送金における取引相手への最初のメッセージです（送信。経路は送信時に選択されます）。`ANSWER`:
お客様の承認または拒否で、問い合わせてきたネットワークに返す必要があります（受信）。`TXID`:
お客様が送金を完了した後の、オンチェーンの取引ハッシュです。`CANCEL`:
お客様が送金をキャンセルした後の、キャンセル通知です。`POLL`:
ステータス照会を提供するネットワークへの照会で、送金が取引相手を待っている間、5分ごとに繰り返されます。
status:
type: string
enum:
- QUEUED
- SENDING
- RETRYING
- DELIVERED
- FAILED
description: >-
`QUEUED`：送信待ちです。`SENDING`：送信を試行中です。`RETRYING`：試行が失敗し、次の試行は`next_attempt_at`に実行されます。`DELIVERED`：相手側がメッセージを受け取りました。`FAILED`：相手側がメッセージを拒否したか、最後の試行が失敗しました。
rail:
type: string
enum:
- INTERNAL
- TRP
- GTR
- TRUST
- VERIFYVASP
- SYGNA
- EMAIL
- ''
description: メッセージを運ぶレール。最初のメッセージについてDiditがレールを選択するまでは空です。
attempts:
type: integer
minimum: 0
description: このメッセージでこれまでに行われた試行回数。ステータスポーリング以外のメッセージは最大6回まで試行されます。
last_error:
type: string
description: >-
最後の試行で発生した失敗の種類です。失敗がない場合は`""`です。例：`email undeliverable`、`trp
identity endpoint unreachable`、`trp transfer inquiry delivery
failed`。取引相手自身の回答が含まれることはなく、その回答は送金の`timeline`に残ります。
GTRがエラーを返した場合は、GTR自身のステータスコードとメッセージが含まれます。レスポンス本文が含まれることはありません。
example: email undeliverable
next_attempt_at:
type: string
format: date-time
nullable: true
description: メッセージが`QUEUED`または`RETRYING`の間に、次の試行が実行される日時。
delivered_at:
type: string
format: date-time
nullable: true
description: 相手側がメッセージを受け取った日時。
TravelRuleDiscoveryStep:
type: object
description: >-
Diditがアウトバウンド送金のために実行した取引相手探索の1ステップで、実行された順に並びます。ルートを持つVASPを特定した最初のステップでチェーンが終了します。
properties:
step:
type: string
enum:
- internal_address_book
- wallet_attribution
- network_lookup
- customer_hint
- end_user
description: >-
`internal_address_book`:
送付先ウォレットの管理権を証明した別のDidit顧客。`wallet_attribution`:
ウォレットのブロックチェーン分析による帰属情報。`network_lookup`:
どのVASPがそのアドレスを保有しているかを回答できるネットワーク。`customer_hint`:
`beneficiary_data`で送信したVASP名、LEIまたは法域。`end_user`:
エンドユーザー（またはお客様）が選択した取引相手、または選択の依頼。
outcome:
type: string
enum:
- match
- miss
- skipped
description: >-
`match`: ステップが取引相手を特定しました。`miss`: 実行されましたが見つかりませんでした。`skipped`:
実行できず、`reason`に理由が示されます。
reason:
type: string
description: >-
機械可読な理由です。一致した場合は`""`になります。値は`no_proven_internal_wallet`、`attribution_disabled`、`already_attributed`、`no_attributed_entity`、`directory_match_no_route`、`gtr_address_lookup_runs_on_dispatch`、`no_membership`、`network_switched_off`、`no_network_address_lookup`、`no_directory_match`、`awaiting_end_user`、`picked_member_without_proven_wallet`のいずれかです。
vasp:
type: string
format: uuid
nullable: true
description: ステップでVASPが指定された場合の、そのディレクトリ上のVASPです。
rail:
type: string
nullable: true
description: ステップで取引相手が見つかった場合に、その取引相手に届くレール。
at:
type: string
format: date-time
TravelRuleNextAction:
type: object
description: >-
`COUNTERPARTY_VASP_NOT_FOUND`または`COUNTERPARTY_VASP_NOT_REACHABLE`の送金を先に進める要素1つです。[送金が停止している理由](/ja/transaction-monitoring/travel-rule#送金が停止している理由)を参照してください。
properties:
action:
type: string
enum:
- select_counterparty_vasp
- declare_self_hosted
- add_vasp_hint
- update_compliance_email
- resend
description: >-
`select_counterparty_vasp`:
エンドユーザーがウォレット所有権ウィジェットで送金先のVASPを選択するか、お客様が`action=beneficiary_vasp`でPATCHします。`declare_self_hosted`:
エンドユーザーがウィジェットでウォレットをセルフホスト型として申告します。`add_vasp_hint`:
VASP名、LEI、またはトラベルアドレス（例:
送金先ウォレットのアドレス帳エントリーの`travel_address`）で取引相手をDiditに伝え、再送信します。`update_compliance_email`と`resend`は`PATCH
/v3/transactions/{transaction_id}/travel-rule/`の`action`値で、それぞれ取引相手のコンプライアンス用メールアドレスを再度指定し、ルーティングを再実行します。
url:
type: string
format: uri
description: >-
ウォレット所有権ウィジェットのリンク。取引にウィジェットセッションが開いている間、`select_counterparty_vasp`と`declare_self_hosted`で返されます。
required:
- action
TravelRuleChainDetails:
type: object
description: >-
送金のチェーンが2つのウォレットをどのように示すか（1つのアドレスが別のアドレスに支払う形態にとどまらない場合）。アカウント型チェーンの送金（EVM、Solana、Tron）では2つのアドレスがそのままウォレットとなるため、空（`{}`）になります。照合、ルーティング、アドレス帳は、まずここからウォレットを読み取ります。
properties:
chain:
type: string
description: 正規チェーン(例:`BTC`、`XRP`、Lightning送金の場合は`LIGHTNING`)。
shape:
type: string
enum:
- utxo
- memo
- lightning
originator:
$ref: '#/components/schemas/TravelRuleChainSide'
beneficiary:
$ref: '#/components/schemas/TravelRuleChainSide'
utxo:
type: object
description: 'UTXO送金の場合: 保存されている入力と出力(金額は10進数の文字列)、およびDiditが各出力を何として解釈したか。'
properties:
inputs:
type: array
items:
$ref: '#/components/schemas/TravelRuleUtxoEntry'
outputs:
type: array
items:
$ref: '#/components/schemas/TravelRuleUtxoEntry'
change_output_indexes:
type: array
items:
type: integer
description: 入力アドレスへ資金を戻す出力。
beneficiary_output_index:
type: integer
nullable: true
description: 受取人に支払うアウトプット。判別できなかった場合はnullです。
lightning:
type: object
description: >-
Lightning送金の場合:
支払いリクエストの内容。常に`kind`(`bolt11`、`bolt12_offer`、`bolt12_invoice`、`bolt12_invoice_request`、`lnurl`、`lightning_address`、`node_id`または`unknown`)を含みます。BOLT11インボイスでは`network`、`payee_node_id`、`payment_hash`、`amount_msat`、`created_at`、`expires_at`が加わり、BOLT12文字列では`blinded_paths`と`payee_node_id`が、LNURLまたはLightning
Addressではその`domain`が加わります。ネットワーク経由での解決は一切行わず、リクエストをデコードするだけです。
additionalProperties: true
warnings:
type: array
items:
type: string
enum:
- declared_originator_not_an_input
- declared_beneficiary_not_an_output
- beneficiary_output_ambiguous
- beneficiary_output_amount_differs
description: >-
確認が必要なUTXOの不整合です。申告された送金人が入力に含まれていない、申告された受取人が出力に含まれていない、受取人の出力を1つに特定できない、または受取人の出力の支払額が取引に記載された金額と異なる場合が該当します。
not_applicable_reason:
type: string
enum:
- LIGHTNING_NO_PAYEE_IDENTIFIER
- LIGHTNING_BOLT12_BLINDED_PAYEE
- LIGHTNING_LNURL_NAMES_NO_PAYEE
description: >-
支払いリクエストに受取人が指定されていないアウトバウンドのLightning送金の場合:
送金が`NOT_APPLICABLE`となる理由。`LIGHTNING_NO_PAYEE_IDENTIFIER`(リクエストに受取人ノードが指定されていない、またはデコードできなかった)、`LIGHTNING_BOLT12_BLINDED_PAYEE`(オファーが受取人をブラインドパスの背後に隠している)、`LIGHTNING_LNURL_NAMES_NO_PAYEE`(LNURLが受取人ではなくサービスを指定している)のいずれかです。同じコードが送金の最後の`timeline`エントリの冒頭にも記載されます。
TravelRuleChainSide:
type: object
description: Diditがチェーンデータから解決した、一方の当事者のウォレットです。
properties:
address:
type: string
description: >-
ウォレット。メモ型ネットワークではクラシックアドレス(XRPのXアドレスはクラシックアドレスとタグに分割されます)、Lightningでは受取人のノードIDまたはLightning
Addressです。
memo:
type: string
description: ウォレットの一部となる宛先タグまたはメモです。ない場合は`""`です。
source:
type: string
enum:
- declared
- x_address
- largest_input
- only_non_change_output
- amount_match
- invoice_payee
- updated
description: >-
ウォレットの取得元です。`declared`（リクエストで指定）、`x_address`（XRPのX-addressから分割）、`largest_input`（最も多く拠出したUTXO入力アドレス）、`only_non_change_output`（おつりではない唯一のUTXO出力）、`amount_match`（送金額を支払う唯一のUTXO出力）、`invoice_payee`（Lightningの支払いリクエストが指定する受取人）、`updated`（後から`action:
update_originator_wallet`で設定）。
TravelRuleUtxoEntry:
type: object
description: UTXO取引の入力または出力1件。チェーンに記録されたとおりの内容です。
required:
- address
properties:
address:
type: string
maxLength: 128
amount:
type: string
nullable: true
description: その通貨自体の単位（satoshiではなくBTC）での10進数文字列。任意。
example: '0.0125'
txid:
type: string
maxLength: 128
description: 任意。入力が使用する取引です。
vout:
type: integer
nullable: true
minimum: 0
description: 任意。入力が使用する出力のインデックスです。
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: >-
お客様のアプリケーションのAPIキーです。Business ConsoleのDevelopers -> API
keysで取得できます。プライマリキーはフルアクセス権を持ちます。名前付きキーにはスコープを設定できます。リソースごとのアクセス権（なし、読み取り、書き込み）、一部のワークフローまたは承認済みセッションへの限定、IPアドレスのリストへの限定、有効期限の設定です。401は、キーが誤っている、失効している、または期限切れであることを意味します。403は、キーが送信されていない、キーにこのリソースやアクションへのアクセス権がない、またはIPリスト外のアドレスからリクエストが送信されたことを意味します。セッションのルートでの404は、セッションがキーのワークフローまたはステータスの対象外であることを意味します。メディアへのアクセス権がないキーでは、画像、動画、PDFのURLがnullで返されます。セッションの書き込み権限がないキーでは、セッションのリンクとトークンがnullで返されます。詳細は次を参照してください:
https://docs.didit.me/console/api-keys
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.