> ## 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：GDPRの忘れられる権利に対応

> DiditのセッションAPIで、KYCまたはKYBのセッションとその全データを削除できます。デフォルトでは顔エンベディングも削除されます。オプトインしたアプリケーションは、画像を含まない生体認証テンプレートを保持できます。



セッション削除プロンプト
        プロンプトをクリップボードにコピー



      
      

\<pre>

\`Delete a single Didit verification session and all of its data, and control what happens to the face biometric data.

Endpoint:
DELETE https://verification.didit.me/v3/session/{session_id}/delete/

Authentication:
Use the x-api-key header with your Didit API key. Privilege: delete:sessions.

Path parameter:
\- session_id (UUID) — works for both User Verification (KYC) and Business Verification (KYB) sessions. Didit resolves the id against both session types.

Optional JSON body (send Content-Type: application/json; omit the body entirely for the default behavior):
\- retain_face_embeddings (boolean | null) — override the application's face_retention_policy for this deletion. true keeps an image-free biometric template anchored to the session's User; false deletes the face embedding with the session; omit or null to follow the application policy.
\- face_retention_days (integer 1-3650) — finite retention duration for the template. Required when retaining unless the application already sets face_retention_days.
\- face_retention_deadline (ISO 8601 datetime, future) — optional hard expiry. The template expires at the earliest of face_retention_days, the application's data-retention window, and this deadline.
\- deletion_instruction ("operational_session_delete" default | "privacy_erasure") — privacy_erasure purges every retained biometric template for the session's User and never retains a new one, regardless of the application policy. Combining privacy_erasure with retain_face_embeddings: true is rejected with 400.
\- instruction_id (string, max 255) — your own durable reference for this deletion instruction (for example your erasure-ticket id). Stored on the audit trail and on any retained template.

curl examples:
Default (follow the application policy; delete_with_session unless you opted in):
curl -X DELETE https://verification.didit.me/v3/session/<SESSION_ID>/delete/ \
-H "x-api-key: <API_KEY>"

Delete the session but keep an image-free biometric template for 365 days:
curl -X DELETE https://verification.didit.me/v3/session/<SESSION_ID>/delete/ \
-H "x-api-key: <API_KEY>" \
-H "Content-Type: application/json" \
-d '{"retain_face_embeddings": true, "face_retention_days": 365}'

Right-to-erasure request (delete the session AND purge every retained template for that person):
curl -X DELETE https://verification.didit.me/v3/session/<SESSION_ID>/delete/ \
-H "x-api-key: <API_KEY>" \
-H "Content-Type: application/json" \
-d '{"deletion_instruction": "privacy_erasure", "instruction_id": "dsar-2026-0142"}'

Response: 200 OK with a JSON body once the deletion has completed (this endpoint no longer returns 204):
\{
"session_id": "<uuid>",
"session_number": 1024,
"face_retention_outcome": "deleted" | "retained_with_user" | "none" | "ineligible_no_vendor_user",
"biometric_template_uuid": "<uuid>" | null,
"biometric_template_expires_at": "<ISO 8601 datetime>" | null,
"deleted_child_verifications": 0
}
\- deleted: the session and its face embedding are deleted (default behavior).
\- retained_with_user: the session is deleted; an image-free biometric template with the returned biometric_template_uuid stays anchored to the User until biometric_template_expires_at, User deletion, privacy erasure, or explicit purge. Manage it with GET/DELETE /v3/biometric-templates/{uuid}/.
\- none: the session had no face embedding (for example a KYB session or a document-only KYC session).
\- ineligible_no_vendor_user: retention was requested but the session has no linked User (no vendor_data), so nothing can anchor the template. The session and its embedding are deleted.
\- biometric_template_expires_at: when the retained template is deleted; null when no template is retained.
\- deleted_child_verifications: for a KYB session, how many verifications it created (its key people's KYC sessions and its corporate owners' KYB sessions, recursively) were deleted with it. Always 0 for a KYC session.

Behavior:
\- The session and every verification attempt it holds are deleted, including results a resubmission replaced: the decision, the extracted data, the associated feature records (ID verification, registry checks, documents, AML, IP, etc.), its reviews and activity log, and all stored files (document images, videos, portraits, selfies, POA documents, extra uploads, and E-signature documents, signed PDFs, evidence PDFs and signature images).
\- A KYB session is deleted together with the verifications it created for its key people and corporate owners. A verification it only links to (for example a reused, already approved KYC) is not deleted.
\- The session disappears immediately from /v3/sessions/ and /v3/session/{id}/decision/, and media URLs issued before the call stop resolving.
\- Webhook deliveries still queued for the session, and their retries, are dropped. Webhooks already delivered are not affected.
\- Ongoing AML monitoring and KYB registry monitoring started by the deleted verifications stop.
\- A retained biometric template never contains the face image, liveness video, document data, extracted identity fields, the decision, or the deleted session's id. It is biometric data, tenant-scoped, used only for your duplicate-face, multi-account, biometric-authentication, and list matching, and it is never used for model training or cross-customer fraud processing.
\- Share tokens issued for the session are NOT revoked, but there is nothing left for them to import: an import with one returns 400 {"share_token": ["Original session does not exist."]}.
\- Blocklist entries created from the session are NOT removed; manage those with the Lists endpoints.
\- Credits already consumed by the verification are NOT refunded.
\- The parent User or Business entity is NOT deleted; use POST /v3/users/delete/ or POST /v3/businesses/delete/ for those. Deleting the User also purges its retained biometric templates. If the User's profile portrait came from this session, the portrait is removed.
\- No webhook fires for the deletion itself.

Idempotency:
Idempotent in effect: the second call to the same session returns 404 because the session no longer exists. Deletion is permanent and cannot be undone.

Failure modes:
\- 400: {"retain_face_embeddings": ["Privacy erasure cannot retain biometric templates."]} or {"detail": "A finite biometric-template retention duration is required."} (retention requested without face_retention_days on the request or the application). Nothing is deleted.
\- 403: {"detail": "You do not have permission to perform this action."} when the key lacks delete:sessions.
\- 404: {"detail": "Not found."} when the session does not exist (or was already deleted).
\- 409: {"detail": "...", "code": "in_filed_report", "reports": [{"uuid": "...", "report_number": "SAR-0001", "report_type": "SAR", "case_uuid": "..."}]} when the session is part of a finalized regulatory report. Nothing is deleted. Delete the reports, then repeat the request.
\- 503: {"detail": "The session could not be deleted because a storage service or a monitoring provider is unavailable. The session is still in place; repeat the request to finish deleting it."} or {"detail": "The biometric-template operation could not finish because an external store is unavailable. The operation is retryable."} The session is still in place; repeat the same request until it returns 200. Some of its stored files or its face embedding may already be deleted. Retries converge on a single template.

Bulk delete:
For many KYC sessions at once, use POST /v3/sessions/delete/ with body {"session_numbers": ["1001", "1002"]} or {"delete_all": true}; it accepts the same retention and instruction fields. Up to 20 matching sessions return 200 with a per-session outcome; more return 202 with a job to poll at GET /v3/sessions/delete/{job_id}/.

Migration note:
Until this release the endpoint returned 204 No Content. It now returns 200 OK with the JSON body above. Update clients that assert on 204. The default deletion behavior is unchanged: existing applications stay on delete_with_session until you explicitly change the policy.

When to call:
\- Customer requests data erasure (GDPR Article 17): use deletion_instruction: "privacy_erasure".
\- Operational clean-up after approval while keeping duplicate detection: retain_face_embeddings: true with a finite face_retention_days.
\- Cleaning up test sessions from a staging application.
\- After exporting a decision PDF for long-term archival outside Didit.

For end-to-end Didit integration, paste in the full prompt at /integration/integration-prompt.`

\</pre>



      
      

貼り付け先

## KYCとKYBのサポート**本人確認（KYC）**と**法人確認 (KYB)**の両方のセッションで使用できます。`session_id`は両方のセッションタイプを対象に照合され、どちらにも同じ削除時の動作となります。生体認証テンプレートの保持はKYCセッションにのみ適用されます。顔エンベディングを持つのはKYCセッションだけであるためです。## 動作- セッションは、保持しているすべての認証試行とともに削除されます。再提出によって置き換えられた結果も含まれます。対象は、判定、抽出されたデータ、関連する機能レコード（本人確認、登記チェック、書類、AML、IP分析など）、レビューとアクティビティログ、保存されているすべてのファイルです。
- **法人確認 (KYB)**セッションを削除すると、そのセッションが主要人物向けに作成した認証（KYC）と法人所有者向けに作成した認証（KYB）も再帰的に削除されます。削除された件数はレスポンスの`deleted_child_verifications`で返されます。再利用した既存の承認済みKYCなど、リンクしているだけの認証は削除されません。
- 電子署名のデータも削除されます。署名対象の書類とその元のWordファイル、署名済みPDF、証拠PDF、署名画像、すべてのフィールド値が対象です。これらのダウンロードパスは`404`を返します。
- セッションは一覧と判定のレスポンスから直ちに消え、呼び出し前に発行されたメディアURLは解決されなくなります。
- そのセッションについてキューに残っているWebhook配信とその再試行は破棄されます。
- 削除された認証によって開始された継続的なAMLモニタリングとKYB登記モニタリングは停止します。
- 削除は永久的で、元に戻すことはできません。復元用のエンドポイントはないため、判定PDFなど必要なものは呼び出す前にエクスポートしてください。
- レスポンスは`200 OK`で、削除の完了後に送信されます。JSONボディには、セッションの顔の生体データがどのように処理されたかが記載されます。クライアントがまだ`204`を想定している場合は、[移行](#204レスポンスからの移行)を参照してください。## 確定済みの規制当局向けレポートに含まれるデータセッションが、確定済みの規制当局向けレポートを持つケースに含まれている場合、リクエストは`409`を返し、何も削除されません。レスポンスは`code: in_filed_report`を使用し、該当する各レポートを示します。```json theme={null}
{
  "detail": "This session is part of a finalized regulatory report, so it cannot be deleted.",
  "code": "in_filed_report",
  "reports": [
    {
      "uuid": "5ec00000-0000-4000-8000-000000000007",
      "report_number": "SAR-0001",
      "report_type": "SAR",
      "case_uuid": "c1a5e000-0000-4000-8000-000000000001"
    }
  ]
}
```[レポートの削除](https://docs.didit.me/ja/management-api/regulatory-reports/delete.md)で各レポートを削除してから、削除を再度実行してください。レポートを削除してもセッションは削除されません。このエンドポイントを再度呼び出すまで、セッションは残ります。## 顔の生体認証データ: 削除または保持ライブネスセルフィーを含むすべてのKYCセッションには、[顔検索1:N](https://docs.didit.me/ja/core-technology/face-search/overview.md)と重複検出に使われる顔エンベディングが含まれます。デフォルトでは、このエンベディングはセッションとともに削除されます（`face_retention_policy: delete_with_session`）。そのため、セッションを削除した人物が再度認証しても、重複として検知されることはありません。セッション削除後も重複検出を維持する必要があるアプリケーションは、**生体認証テンプレートの保持**を有効にできます。この場合、Diditは通常どおりセッションとそのすべてのデータを削除し、セッションの[ユーザー](https://docs.didit.me/ja/entities/users/overview.md)に紐づく、画像を含まない顔の生体認証テンプレートを1件だけ、別途管理して保持します。> [!WARNING]
>
> 保持された生体認証テンプレートは生体認証データです。匿名データではなく、一時的なデータでもなく、セッションとともに削除されることもありません。予定された有効期限、それより早い適用法上の期限、ユーザーの削除、プライバシー消去リクエスト、明示的なパージのいずれかに至るまで保持されます。保持は、データ管理者の指示とプライバシー通知がこれを対象としている場合にのみ有効にしてください。保持されるテンプレートに含まれるものと含まれないもの:| 保持されるもの | 保持されないもの |
| - | - |
| 照合に使用される数値形式の顔テンプレート | 顔画像、ライブネス動画、書類画像、顔写真の切り抜き、その他すべてのメディア |
| 新たに生成されるランダムなテンプレートIDと、不透明な`provenance_reference` | 削除されたセッションのID、番号、判定、抽出された本人情報フィールド、特徴量ペイロード |
| 所有者であるユーザー（`vendor_user_uuid`、現在の`vendor_data`） | ブロックリストの状態、過去の一致、不正ラベル、組織間の本人性に関する主張 |
| 保持メタデータ: `retained_at`、`expires_at`、ポリシー、オーバーライド、指示クラス、`instruction_id`、操作を行ったプリンシパルのID | 操作者のメールアドレス |保持は、適用範囲の広いものから順に次の3か所で設定します。1) **アプリケーションのポリシー**: **Business Console → App Settings → Data retention**、または`PATCH /v3/webhook/`（`face_retention_policy`、`face_retention_days`）で設定します。[データ保持](https://docs.didit.me/ja/console/data-retention.md#生体認証テンプレートの保持)を参照してください。
2) **呼び出しごとのオーバーライド**: このエンドポイントと[セッションの一括削除](https://docs.didit.me/ja/management-api/sessions/batch-delete.md)で`retain_face_embeddings`を指定します。
3) **指示クラス**: `deletion_instruction`で指定します。`privacy_erasure`の指示は常に最優先されます。そのユーザーについて保持されているすべてのテンプレートをパージし、新たなテンプレートを保持することはありません。### リクエストボディすべてのフィールドは任意です。アプリケーションのポリシーに従う場合は、ボディを省略してください。| フィールド | 型 | 説明 |
| - | - | - |
| `retain_face_embeddings` | booleanまたはnull | この削除についてアプリケーションのポリシーをオーバーライドします。`true`はテンプレートを保持し、`false`はエンベディングをセッションとともに削除します。`null`または省略した場合はポリシーに従います。 |
| `face_retention_days` | integer（1-3650） | テンプレートの有限の保持期間です。テンプレートを保持する場合は必須です。ただし、アプリケーションですでに`face_retention_days`が設定されている場合を除きます。 |
| `face_retention_deadline` | datetime（ISO 8601） | 任意の上限となる有効期限です。未来の日時である必要があります。 |
| `deletion_instruction` | `operational_session_delete`（デフォルト）または`privacy_erasure` | 指示のクラスです。`privacy_erasure`は、セッションを削除する前に、そのセッションのユーザーについて保持されているすべてのテンプレートをパージします。`retain_face_embeddings: true`とは併用できません。 |
| `instruction_id` | string（最大255文字） | この指示に対するお客様側の永続的な参照IDです。たとえば消去チケットのIDなどです。監査証跡と、保持されるすべてのテンプレートに記録されます。省略した場合はDiditが生成し、テンプレートの詳細で確認できます。 |### レスポンス```json theme={null}
{
  "session_id": "4c5c7f3a-3b1d-4b7e-9c39-2b4f7e6a1d02",
  "session_number": 1024,
  "face_retention_outcome": "retained_with_user",
  "biometric_template_uuid": "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b",
  "biometric_template_expires_at": "2027-10-09T10:15:00Z",
  "deleted_child_verifications": 0
}
```| フィールド | 説明 |
| - | - |
| `session_id` | 削除されたセッションです。 |
| `session_number` | 削除されたセッションの番号です。 |
| `face_retention_outcome` | セッションの顔の生体認証データがどのように処理されたかを示します。下表を参照してください。 |
| `biometric_template_uuid` | `face_retention_outcome`が`retained_with_user`の場合は、保持された生体認証テンプレートのIDです。それ以外の場合は`null`です。 |
| `biometric_template_expires_at` | 保持された生体認証テンプレートが削除される日時です。テンプレートが保持されない場合は`null`です。 |
| `deleted_child_verifications` | KYBセッションの場合、そのセッションが作成した認証（主要人物のKYCセッションと法人所有者のKYBセッションを再帰的に含む）のうち、一緒に削除された件数です。KYCセッションでは常に`0`です。 || `face_retention_outcome` | 意味 |
| - | - |
| `deleted` | セッションとその顔エンベディングが削除されました。デフォルトの動作です。 |
| `retained_with_user` | セッションは削除されました。画像を含まない生体認証テンプレートが1件、ユーザーに紐づいて保持されています。そのIDは`biometric_template_uuid`です。[生体認証テンプレートAPI](https://docs.didit.me/ja/management-api/biometric-templates/overview.md)で管理します。 |
| `none` | セッションに削除または保持の対象となる顔エンベディングがありませんでした（KYBセッションや、ライブネスセルフィーのないKYCセッションなど）。 |
| `ineligible_no_vendor_user` | 保持がリクエストされましたが、セッションがユーザーに紐づいていない（`vendor_data`なしで作成された）ため、テンプレートを紐づける先がありません。セッションとそのエンベディングは削除されます。この対象外となったことは監査証跡に記録されます。 |このレスポンスは、Diditが削除指示を受け付けて適用したことを示すものです。消去証明書ではありません。後で監査証跡と照合できるよう、`instruction_id`をお客様自身の消去ログに記録してください。### 保持期間と有効期限保持されるすべてのテンプレートには、有限の`expires_at`が設定されます。Diditは次のうち最も早い日時を設定します。1) リクエストの`face_retention_days`。リクエストで省略された場合は、アプリケーションの`face_retention_days`
2) アプリケーションの一般的なデータ保持期間（設定されている場合）
3) リクエストの`face_retention_deadline`（指定されている場合）有限の期間を指定せずにテンプレートを保持しようとするリクエストは`400`で拒否され、何も削除されません。保持されたテンプレートが、適用される顧客の指示、利用目的の終了、設定された有効期限、データ主体による消去指示、法定の生体認証データ保持期限のうち最も早いものを超えて存続することはありません。ユーザーに適用される法令を満たす期間を選択する責任はお客様にあります。適用されるルールで求められる場合は、必ずより短い期間を選択してください。### プライバシー消去データ主体からのリクエストに対応する場合は、`deletion_instruction: "privacy_erasure"`を送信してください。Diditは、そのセッションのユーザーに紐付く保持中の生体認証テンプレートをすべて消去し、その後セッションとそのエンベディングを削除します。アプリケーションの保持ポリシーでプライバシー消去の指示を上書きすることはできず、`retain_face_embeddings: true`は`400`で拒否されます。[ユーザーの一括削除](https://docs.didit.me/ja/management-api/users/delete.md)でユーザーを削除した場合も、そのユーザーの保持中のテンプレートは消去されます。## 影響を受けないものセッションを削除しても、以下は自動的にはクリーンアップされません。消去権に基づくリクエストに対応する場合は、これらを個別に処理してください。- セッションから作成された**ブロックリストのエントリ**(顔または書類)はそのまま残ります。[ブロックリスト](https://docs.didit.me/ja/entities/users/blocklist.md)から削除してください。顔のブロックリストエントリは、保持中のテンプレートとは独立した独自の生体情報エントリを保持します。
- セッションに対してすでに発行された**共有トークン**は失効しませんが、インポートできるデータはもう残っていません。そのトークンを使った[インポート](https://docs.didit.me/ja/sessions-api/share-session/import.md)は、`{"share_token": ["Original session does not exist."]}`とともに`400`を返します。
- セッションについて**すでに配信されたWebhook**は影響を受けません。キューに残っている配信とその再試行は破棄されます。削除そのものに対してWebhookは送信されません。
- 認証によって**すでに消費されたクレジット**は払い戻されません。
- 電子署名ステップによって署名者に**すでにメール送信された署名済みコピー**は署名者のメールボックスにあり、影響を受けません。
- 親の**User**または**Business**エンティティは削除されません。これらには[Delete Users](https://docs.didit.me/ja/management-api/users/delete.md)または[Delete Businesses](https://docs.didit.me/ja/management-api/businesses/delete.md)を使用してください。ユーザーのプロフィール画像が削除されたセッションに由来する場合、その画像は削除されます。
- **保持中の生体認証テンプレート**(オプトインした場合のみ)は、期限切れになるか消去するまで残ります。[Biometric Templates API](https://docs.didit.me/ja/management-api/biometric-templates/purge.md)を使用するか、ユーザーを削除するか、同じユーザーの別のセッションを`deletion_instruction: "privacy_erasure"`で削除することで消去できます。## 例> [tab] デフォルト(アプリケーションのポリシー)
>
> ```bash theme={null}
> curl -X DELETE https://verification.didit.me/v3/session/4c5c7f3a-.../delete/ \
>   -H "x-api-key: YOUR_API_KEY"
> ```
>
> オプトインしていないアプリケーションでのレスポンス:
>
> ```json theme={null}
> {
>   "session_id": "4c5c7f3a-3b1d-4b7e-9c39-2b4f7e6a1d02",
>   "session_number": 1024,
>   "face_retention_outcome": "deleted",
>   "biometric_template_uuid": null,
>   "biometric_template_expires_at": null,
>   "deleted_child_verifications": 0
> }
> ```> [tab] 生体認証テンプレートを保持する
>
> ```bash theme={null}
> curl -X DELETE https://verification.didit.me/v3/session/4c5c7f3a-.../delete/ \
>   -H "x-api-key: YOUR_API_KEY" \
>   -H "Content-Type: application/json" \
>   -d '{"retain_face_embeddings": true, "face_retention_days": 365, "instruction_id": "cleanup-2026-08-0142"}'
> ```
>
> ```json theme={null}
> {
>   "session_id": "4c5c7f3a-3b1d-4b7e-9c39-2b4f7e6a1d02",
>   "session_number": 1024,
>   "face_retention_outcome": "retained_with_user",
>   "biometric_template_uuid": "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b",
>   "biometric_template_expires_at": "2027-10-09T10:15:00Z",
>   "deleted_child_verifications": 0
> }
> ```> [tab] オプトイン済みアプリで削除を強制する
>
> ```bash theme={null}
> curl -X DELETE https://verification.didit.me/v3/session/4c5c7f3a-.../delete/ \
>   -H "x-api-key: YOUR_API_KEY" \
>   -H "Content-Type: application/json" \
>   -d '{"retain_face_embeddings": false}'
> ```
>
> ```json theme={null}
> {
>   "session_id": "4c5c7f3a-3b1d-4b7e-9c39-2b4f7e6a1d02",
>   "session_number": 1024,
>   "face_retention_outcome": "deleted",
>   "biometric_template_uuid": null,
>   "biometric_template_expires_at": null,
>   "deleted_child_verifications": 0
> }
> ```> [tab] プライバシー消去
>
> ```bash theme={null}
> curl -X DELETE https://verification.didit.me/v3/session/4c5c7f3a-.../delete/ \
>   -H "x-api-key: YOUR_API_KEY" \
>   -H "Content-Type: application/json" \
>   -d '{"deletion_instruction": "privacy_erasure", "instruction_id": "dsar-2026-0142"}'
> ```
>
> 最初にセッションのユーザーに紐付く保持中のテンプレートがすべて消去され、その後セッションが削除されます:
>
> ```json theme={null}
> {
>   "session_id": "4c5c7f3a-3b1d-4b7e-9c39-2b4f7e6a1d02",
>   "session_number": 1024,
>   "face_retention_outcome": "deleted",
>   "biometric_template_uuid": null,
>   "biometric_template_expires_at": null,
>   "deleted_child_verifications": 0
> }
> ```> [tab] ユーザーのないセッション
>
> `vendor_data`なしで作成されたセッションには、テンプレートを紐付けるユーザーが存在しません:
>
> ```bash theme={null}
> curl -X DELETE https://verification.didit.me/v3/session/7a1e9c2d-.../delete/ \
>   -H "x-api-key: YOUR_API_KEY" \
>   -H "Content-Type: application/json" \
>   -d '{"retain_face_embeddings": true, "face_retention_days": 365}'
> ```
>
> ```json theme={null}
> {
>   "session_id": "7a1e9c2d-5f4b-4c3a-8e2d-1b0a9f8e7d6c",
>   "session_number": 1031,
>   "face_retention_outcome": "ineligible_no_vendor_user",
>   "biometric_template_uuid": null,
>   "biometric_template_expires_at": null,
>   "deleted_child_verifications": 0
> }
> ```> [tab] 法人確認 (KYB) セッション
>
> ```bash theme={null}
> curl -X DELETE https://verification.didit.me/v3/session/bs-01HJX1.../delete/ \
>   -H "x-api-key: YOUR_API_KEY"
> ```
>
> 法人確認は、主要人物に対して作成された3件の認証とともに削除されます:
>
> ```json theme={null}
> {
>   "session_id": "0f3c9b7e-2d1a-4e5f-8c6b-7a9d8e1f2c3b",
>   "session_number": 88,
>   "face_retention_outcome": "none",
>   "biometric_template_uuid": null,
>   "biometric_template_expires_at": null,
>   "deleted_child_verifications": 3
> }
> ```## エラー| ステータス | 発生条件 | 本文 |
| - | - | - |
| `400` | `privacy_erasure`と`retain_face_embeddings: true`を組み合わせた場合 | `{"retain_face_embeddings": ["Privacy erasure cannot retain biometric templates."]}` |
| `400` | リクエストにもアプリケーションにも有限の期間が指定されていない状態で保持を要求した場合 | `{"detail": "A finite biometric-template retention duration is required."}` |
| `403` | 認証情報に`delete:sessions`がない、またはセッションを所有していない場合 | `{"detail": "You do not have permission to perform this action."}` |
| `404` | 不明なセッション、またはすでに削除されたセッションの場合 | `{"detail": "Not found."}` |
| `503` | セッションの削除中に、ストレージサービスまたはモニタリングプロバイダーが利用できなかった場合。 | `{"detail": "The session could not be deleted because a storage service or a monitoring provider is unavailable. The session is still in place; repeat the request to finish deleting it."}` |
| `503` | テンプレートの保持または消去中に、生体情報ストアが利用できなかった場合。再試行は同一のテンプレートに対して行われます。 | `{"detail": "The biometric-template operation could not finish because an external store is unavailable. The operation is retryable."}` |`400`の場合は何も削除されません。`503`の場合はセッションが残っているため、`200`が返るまで同じリクエストを繰り返してください。保存されたファイルの一部や顔エンベディングはすでに削除されている可能性があるため、`503`の後はそれらに依存しないでください。## 権限`delete:sessions`権限が必要です。同じ権限で、ユーザー認証 (KYC) と企業認証 (KYB) の両方のセッション、および保持設定の上書きを扱えます。## 一括削除KYCセッションの一括操作には`POST /v3/sessions/delete/`を使用します。同じ保持および指示のフィールドを受け付けます。条件に一致するセッションは最大20件まで1回のリクエストで削除され、セッションごとの結果が返されます。それを超える場合は[削除ジョブ](https://docs.didit.me/ja/management-api/sessions/get-deletion-job.md)として実行されます。[Batch Delete Sessions](https://docs.didit.me/ja/management-api/sessions/batch-delete.md)を参照してください。## 204レスポンスからの移行このリリースまで、このエンドポイントは`204 No Content`を返していました。現在は、すべての削除で`face_retention_outcome`が報告されるよう、上記のJSON本文とともに`200 OK`を返します。`204`を前提としているクライアントを更新してください。デフォルトの動作は変わりません。既存のアプリケーションは`delete_with_session`のままで、移行によってお客様に代わって保持が有効になることはありません。Consoleまたは`PATCH /v3/webhook/`で明示的に有効にしてください。## 関連項目- [生体認証テンプレート](https://docs.didit.me/ja/management-api/biometric-templates/overview.md)
- [データ保持](https://docs.didit.me/ja/console/data-retention.md)
- [セッションの概要](https://docs.didit.me/ja/sessions-api/overview.md)


## OpenAPI

````yaml ja/openapi-25.json DELETE /v3/session/{sessionId}/delete/
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/session/{sessionId}/delete/:
    delete:
      tags:
        - Sessions
      summary: 検証セッション(KYCまたはKYB)を削除
      description: >-
        `session_id`を指定して、ユーザー認証 (KYC) または法人確認 (KYB)
        の検証セッションを1件削除します。IDはまずKYCセッション、次にKYBセッションの順で照合されるため、どちらの種類もこの1つのURLで削除できます。


        **削除されるもの:**

        -
        セッションと、そのセッションに含まれるすべての認証試行。再提出によって置き換えられた結果も含みます。対象は判定、抽出データ、関連するすべての機能レコード
        (本人確認、顔、ライブネス検知、顔照合、AML、法人登記チェック、IP分析など)、レビュー、アクティビティログです。

        - セッションが所有するすべての保存ファイル。書類の表面・裏面の写真
        (フル、切り抜き、プライバシー保護のためのぼかし処理済みの各バリエーション)、書類撮影の動画、顔写真の切り抜き、NFCチップの顔写真と署名画像、顔の参照画像、ライブネス検知の動画、顔照合のソース画像・ターゲット画像、住所証明の書類、その他のアップロードファイル
        (KYC)、アップロードされた企業書類とその他のファイル (KYB) が含まれます。電子署名の書類、署名済みPDF、証拠PDF、署名画像
        (KYCおよびKYB) は、ダウンロードパスが機能しなくなります。発行済みのメディアURL
        (`https://<media-host>/...`) は解決されなくなります。

        - セッションの顔データ。画像を含まないテンプレートを保持することを選択した場合を除き、顔エンベディングも削除されます
        (**顔の生体データ**を参照)。

        - セッションについてキューに残っているWebhook配信とその再試行。すでに配信済みのWebhookには影響しません。

        - 法人確認 (KYB) セッションの場合: そのセッションが主要人物 (KYC) および法人株主 (KYB)
        のために作成した認証が再帰的に削除され、`deleted_child_verifications`として報告されます。再利用した既存の承認済みKYCなど、リンクしているだけの認証は削除されません。


        セッションはすべての読み取りエンドポイントから即座に消えます。`GET
        /v3/session/{sessionId}/decision/`は`404`を返し、`GET
        /v3/sessions/`の一覧にも表示されなくなります。削除された認証によって開始された継続的なAMLモニタリングとKYB法人登記モニタリングは停止します。


        **影響を受けないもの:** このセッションから作成されたブロックリストのエントリ (顔または書類)
        は削除**されません**。これらはブロックリストのエンドポイントで管理してください。セッションに対して発行された共有トークンは失効しませんが、インポートできるデータは残っていません。そのトークンでインポートすると、`400`と`{"share_token":
        ["Original session does not
        exist."]}`が返されます。消費済みのクレジットは払い戻し**されません**。親であるUserまたはBusinessエンティティは削除**されません**。これらを削除するには`POST
        /v3/users/delete/`または`POST
        /v3/businesses/delete/`を使用してください。Userのプロフィール顔写真がこのセッションから取得されたものである場合、その顔写真もあわせて削除されます。


        **顔の生体データ:** デフォルトでは、セッションの顔エンベディングはセッションとともに削除されます
        (`face_retention_outcome: deleted`)。生体認証テンプレートの保持をオプトインしたアプリケーション
        (`PATCH /v3/webhook/`で`face_retention_policy:
        retain_until_user_deleted`を設定)、または`retain_face_embeddings:
        true`を指定したリクエストでは、重複検出、顔検索、生体認証が引き続き機能するよう、画像を含まない顔の生体認証テンプレートが1件、セッションのUserに紐づけて別途管理される形で保持されます
        (`retained_with_user`)。このテンプレートには、顔画像、メディア、本人情報フィールド、判定、削除されたセッションのIDは一切含まれません。これは生体データであり、`biometric_template_expires_at`の時点で削除されます。それ以前でも、Userの削除、プライバシー消去、または`/v3/biometric-templates/`による明示的な削除が行われた場合は削除されます。Userがリンクされていないセッションではテンプレートを保持できません
        (`ineligible_no_vendor_user`)。データ主体からの請求には`deletion_instruction:
        privacy_erasure`を送信してください。そのUserについて保持されているすべてのテンプレートが削除され、新たなテンプレートが保持されることはありません。


        **元に戻せません:** 削除は恒久的であり、復元用のエンドポイントはありません。必要なもの (判定のPDFなど)
        は、呼び出す前にエクスポートしてください。


        **副作用:** 削除に対してWebhookは送信されません。


        **レスポンス:** 削除が完了すると`200
        OK`が返され、JSONボディで`face_retention_outcome`、保持されたテンプレートの有効期限、KYBセッションの場合は`deleted_child_verifications`が報告されます。このエンドポイントの以前のバージョンは`204
        No
        Content`を返していました。`204`を前提としているクライアントは更新してください。`instruction_id`は自社の消去ログに保管してください。


        **冪等性:**
        HTTPレベルでは冪等ではありません。最初の呼び出しは`200`を返し、繰り返すとセッションが解決されなくなっているため`404`を返します。`503`が返された場合、セッションはまだ残っています。同じリクエストを再度送信して削除を完了してください。


        **認証:**
        アプリケーションのAPIキーを`x-api-key`ヘッダーで送信してください。セッションはそのアプリケーションに属している必要があります。`delete:sessions`権限を持つ場合に限り、コンソールユーザーのアクセストークン
        (`Authorization: Bearer ...`)
        でもこのエンドポイントを呼び出せます。認証の失敗と権限の不足はいずれも`403`を返します。このAPIが`401`を返すことはありません。


        **レート制限:**
        すべてのPOST/PATCH/DELETEエンドポイントで共有される書き込み枠として、APIキーごとに毎分300リクエストまでです。超過すると`429`が返されます。


        KYCセッションを数値の`session_number`で一括削除するには、代わりに`POST
        /v3/sessions/delete/`を使用してください。


        **提出済みの規制当局向けレポート:**
        選択したデータが確定済みの規制当局向けレポートに含まれている場合、リクエスト全体が`409`で拒否され、何も削除されません。ボディは`code:
        in_filed_report`を使用し、各レポートを`uuid`、`report_number`、`report_type`、`case_uuid`で示します。レポートを削除してから、リクエストを再度送信してください。
      operationId: delete_v3_session_by_id
      parameters:
        - in: path
          name: sessionId
          required: true
          description: >-
            削除するユーザー認証 (KYC) または法人確認 (KYB) セッションのUUID (`session_id`)
            です。セッション作成時に返された値を指定します。ハイフン区切りの正規形式のUUIDである必要があります。UUID以外の値はルートに一致せず、`404`が返されます。
          schema:
            type: string
            format: uuid
            example: 11111111-2222-3333-4444-555555555555
      requestBody:
        required: false
        description: 任意。ボディを完全に省略すると、アプリケーションのデータ保持ポリシーに従って運用上の削除が行われます。
        content:
          application/json:
            schema:
              type: object
              properties:
                retain_face_embeddings:
                  type: boolean
                  nullable: true
                  description: >-
                    この削除について、アプリケーションの`face_retention_policy`を上書きします。`true`の場合、セッションの削除後も、画像を含まない顔の生体認証テンプレートを1つ、セッションのユーザーに紐付けて保持します。`false`の場合、顔エンベディングはセッションとともに削除されます。省略するか`null`にすると、アプリケーションのポリシーに従います。KYBセッション、および顔エンベディングのないセッションでは無視されます。
                  example: true
                face_retention_days:
                  type: integer
                  minimum: 1
                  maximum: 3650
                  description: >-
                    保持されるテンプレートの有限の保持期間（日数）です。テンプレートを保持する場合は必須です。ただし、アプリケーションですでに`face_retention_days`が設定されている場合を除きます。テンプレートの`expires_at`は、この期間、アプリケーションの一般的なデータ保持期間、`face_retention_deadline`のうち最も早いものになります。
                  example: 365
                face_retention_deadline:
                  type: string
                  format: date-time
                  description: 保持されるテンプレートの任意の強制有効期限です。未来の日時である必要があります。
                  example: '2027-08-28T00:00:00Z'
                deletion_instruction:
                  type: string
                  enum:
                    - operational_session_delete
                    - privacy_erasure
                  default: operational_session_delete
                  description: >-
                    指示の種類。`operational_session_delete`はセッションを削除し、ポリシーまたは`retain_face_embeddings`で指定されている場合にのみテンプレートを保持します。`privacy_erasure`は、セッションのユーザーに紐づく保持済みの生体認証テンプレートをすべて完全に削除してからセッションを削除します。アプリケーションのポリシーで上書きすることはできず、`retain_face_embeddings:
                    true`と組み合わせることもできません（`400`）。
                  example: operational_session_delete
                instruction_id:
                  type: string
                  maxLength: 255
                  description: >-
                    この削除指示に対するお客様の永続的な参照ID（例:
                    消去チケットのID）です。監査証跡と、保持されるテンプレートに記録されます。省略した場合はDiditが生成します。
                  example: dsar-2026-0142
            examples:
              Retain a biometric template:
                summary: セッションを削除し、画像を含まないテンプレートを365日間保持
                value:
                  retain_face_embeddings: true
                  face_retention_days: 365
                  instruction_id: post-approval-cleanup-2026-08
              Force deletion on an opted-in application:
                summary: アプリケーションのポリシーに関係なく顔エンベディングを削除
                value:
                  retain_face_embeddings: false
              Privacy erasure:
                summary: データ主体からの請求：セッションを削除し、その人物について保持されているすべてのテンプレートを完全に消去します
                value:
                  deletion_instruction: privacy_erasure
                  instruction_id: dsar-2026-0142
      responses:
        '200':
          description: >-
            セッションが削除されました。ボディには、セッションの顔の生体データがどうなったか、およびKYBセッションの場合はそのセッションが作成した認証のうち何件が併せて削除されたかが示されます。
          content:
            application/json:
              schema:
                type: object
                properties:
                  session_id:
                    type: string
                    format: uuid
                    description: 削除されたセッションです。
                  session_number:
                    type: integer
                    nullable: true
                    description: 削除されたセッションの番号です。
                  face_retention_outcome:
                    type: string
                    enum:
                      - retained_with_user
                      - deleted
                      - none
                      - ineligible_no_vendor_user
                    description: >-
                      セッションの顔生体データがどう処理されたか。`deleted`:
                      顔エンベディングはセッションとともに削除されました（デフォルト）。`retained_with_user`:
                      セッションは削除され、画像を含まない生体認証テンプレートが1件Userに紐付いて残ります。`biometric_template_uuid`を参照してください。`none`:
                      セッションに顔エンベディングがありませんでした（例:
                      KYBセッション、またはライブネスのセルフィーがないKYCセッション）。`ineligible_no_vendor_user`:
                      保持がリクエストされましたが、セッションに紐付くUserがないため、エンベディングはセッションとともに削除されました。このエンドポイントでは、生体データストアの障害がこのフィールドで報告されることはありません。その場合は`503`を返し、セッションは削除されません。
                  biometric_template_uuid:
                    type: string
                    format: uuid
                    nullable: true
                    description: >-
                      `face_retention_outcome`が`retained_with_user`の場合に保持された生体認証テンプレートのID。それ以外の場合は`null`です。`/v3/biometric-templates/{template_uuid}/`で管理します。
                  biometric_template_expires_at:
                    type: string
                    format: date-time
                    nullable: true
                    description: >-
                      `face_retention_outcome`が`retained_with_user`の場合に、保持された生体認証テンプレートが削除される日時。テンプレートが保持されていない場合は`null`です。
                  deleted_child_verifications:
                    type: integer
                    description: >-
                      法人確認
                      (KYB)セッションの場合：そのセッションが作成した認証（主要人物のKYCセッションと法人所有者のKYBセッションを再帰的に含む）のうち、セッションとともに削除された件数。KYCセッションでは常に`0`です。
              examples:
                Deleted (default):
                  value:
                    session_id: 4c5c7f3a-3b1d-4b7e-9c39-2b4f7e6a1d02
                    session_number: 1024
                    face_retention_outcome: deleted
                    biometric_template_uuid: null
                    biometric_template_expires_at: null
                    deleted_child_verifications: 0
                Retained with User:
                  value:
                    session_id: 4c5c7f3a-3b1d-4b7e-9c39-2b4f7e6a1d02
                    session_number: 1024
                    face_retention_outcome: retained_with_user
                    biometric_template_uuid: 9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b
                    biometric_template_expires_at: '2027-10-09T10:15:00Z'
                    deleted_child_verifications: 0
                'Ineligible: no User':
                  summary: vendor_dataなしで作成されたセッションで保持がリクエストされた
                  value:
                    session_id: 7a1e9c2d-5f4b-4c3a-8e2d-1b0a9f8e7d6c
                    session_number: 1031
                    face_retention_outcome: ineligible_no_vendor_user
                    biometric_template_uuid: null
                    biometric_template_expires_at: null
                    deleted_child_verifications: 0
                KYB session:
                  value:
                    session_id: 0f3c9b7e-2d1a-4e5f-8c6b-7a9d8e1f2c3b
                    session_number: 88
                    face_retention_outcome: none
                    biometric_template_uuid: null
                    biometric_template_expires_at: null
                    deleted_child_verifications: 3
                  summary: 主要人物向けに作成した3件の認証とあわせて削除された法人確認
        '400':
          description: 検証エラー：何も削除されません。
          content:
            application/json:
              examples:
                Privacy erasure cannot retain:
                  value:
                    retain_face_embeddings:
                      - Privacy erasure cannot retain biometric templates.
                No finite retention duration:
                  summary: リクエストにもアプリケーションにもface_retention_daysがない状態で保持がリクエストされた
                  value:
                    detail: >-
                      A finite biometric-template retention duration is
                      required.
        '403':
          description: >-
            認証または権限の失敗です。キーがない場合も`403`を返し、誤った、失効した、または期限切れのキーの場合は`401`を返します。例外として、`sessionId`が有効なセッションに解決されない場合は、認証前の所有者検索が先に`404`を返します。これは認証情報がないか無効な場合でも同様です。
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              examples:
                Missing or invalid API key:
                  summary: x-api-keyヘッダーがないか、キーが無効です
                  value:
                    detail: >-
                      Authentication credentials were not provided or are
                      invalid.
                Insufficient permission:
                  summary: delete:sessions権限のないユーザートークン、またはセッションを所有していないアプリケーションの認証情報
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: >-
            この`session_id`の有効なKYCまたはKYBセッションは存在しません。idが不明か、セッションがすでに削除されています（削除に成功した後に再度削除するとここに該当します）。
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              examples:
                Not Found:
                  summary: 不明なセッション、またはすでに削除されたセッション
                  value:
                    detail: Not found.
        '409':
          description: セッションは確定済みの規制当局向けレポートに含まれています。何も削除されません。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InFiledReportError'
        '429':
          description: >-
            共有の書き込みレート制限を超えました（APIキーごとに1分あたりPOST/PATCH/DELETEリクエスト300件）。再試行する前に、`Retry-After`および`X-RateLimit-*`レスポンスヘッダーを確認してください。
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              examples:
                Rate limited:
                  summary: 書き込みの上限に達しました
                  value:
                    detail: >-
                      Write request rate limit exceeded. You can make up to 300
                      requests per minute.
        '503':
          description: >-
            ストレージサービス、生体データストア、またはモニタリングプロバイダーが利用できなかったため、削除を完了できませんでした。セッションはそのまま残っています。`200`が返るまで同じリクエストを繰り返してください。保存されたファイルの一部や顔エンベディングがすでに削除されている可能性があるため、`503`の後はそれらに依存しないでください。再試行は単一のテンプレートに収束します。
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              examples:
                Session deletion unavailable:
                  summary: ストレージサービスまたはモニタリングプロバイダーが利用できませんでした
                  value:
                    detail: >-
                      The session could not be deleted because a storage service
                      or a monitoring provider is unavailable. The session is
                      still in place; repeat the request to finish deleting it.
                Biometric store unavailable:
                  summary: テンプレートの保持または消去中に、生体認証ストアが利用できませんでした
                  value:
                    detail: >-
                      The biometric-template operation could not finish because
                      an external store is unavailable. The operation is
                      retryable.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl (default policy)
          source: |-
            curl -X DELETE \
              https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/delete/ \
              -H 'x-api-key: YOUR_API_KEY'
        - lang: curl
          label: curl (retain template)
          source: |-
            curl -X DELETE \
              https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/delete/ \
              -H 'x-api-key: YOUR_API_KEY' \
              -H 'Content-Type: application/json' \
              -d '{"retain_face_embeddings": true, "face_retention_days": 365}'
        - lang: curl
          label: curl (privacy erasure)
          source: |-
            curl -X DELETE \
              https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/delete/ \
              -H 'x-api-key: YOUR_API_KEY' \
              -H 'Content-Type: application/json' \
              -d '{"deletion_instruction": "privacy_erasure", "instruction_id": "dsar-2026-0142"}'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.sessions.delete(
                "11111111-2222-3333-4444-555555555555",
                retain_face_embeddings=True,
                face_retention_days=365,
                instruction_id="post-approval-cleanup-2026-08",
            )
            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.sessions.delete("11111111-2222-3333-4444-555555555555", {
              retain_face_embeddings: true,
              face_retention_days: 365,
              instruction_id: "post-approval-cleanup-2026-08",
            });

            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.Delete(ctx, \"11111111-2222-3333-4444-555555555555\", didit.SessionsDeleteParams{\n\tRetainFaceEmbeddings: didit.Bool(true),\n\tFaceRetentionDays:    didit.Int(365),\n\tInstructionID:        didit.String(\"post-approval-cleanup-2026-08\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: >-
            import me.didit.Didit;

            import me.didit.types.SessionsDeleteParams;


            // Reads DIDIT_API_KEY.

            Didit client = new Didit();


            var result =
            client.sessions().delete("11111111-2222-3333-4444-555555555555",
            SessionsDeleteParams.builder()
                    .retainFaceEmbeddings(true)
                    .faceRetentionDays(365L)
                    .instructionId("post-approval-cleanup-2026-08")
                    .build());
            System.out.println(result);
        - lang: php
          label: PHP
          source: >-
            <?php


            require 'vendor/autoload.php';


            use Didit\DiditClient;


            // Reads DIDIT_API_KEY.

            $didit = new DiditClient();


            $result =
            $didit->sessions->delete('11111111-2222-3333-4444-555555555555', [
                'retain_face_embeddings' => true,
                'face_retention_days' => 365,
                'instruction_id' => 'post-approval-cleanup-2026-08',
            ]);

            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

            # Reads DIDIT_API_KEY.
            didit = Didit::Client.new

            result = didit.sessions.delete(
              "11111111-2222-3333-4444-555555555555",
              retain_face_embeddings: true,
              face_retention_days: 365,
              instruction_id: "post-approval-cleanup-2026-08"
            )
            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.Sessions.DeleteAsync("11111111-2222-3333-4444-555555555555",
            new SessionsDeleteParams

            {
                RetainFaceEmbeddings = true,
                FaceRetentionDays = 365,
                InstructionId = "post-approval-cleanup-2026-08",
            });

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    InFiledReportError:
      type: object
      description: >-
        選択したデータが確定済みの規制レポートに含まれているため、削除は拒否されます。何も削除されません。レポートを削除してから、リクエストを繰り返してください。
      required:
        - detail
        - code
      properties:
        detail:
          type: string
        code:
          type: string
          enum:
            - in_filed_report
          description: 確定済みの規制レポートによって削除がブロックされた場合の固定のエラーコード。
        reports:
          type: array
          items:
            $ref: '#/components/schemas/FiledRegulatoryReport'
          description: 人物、企業、ケース、またはセッションの削除を妨げているレポート。
        transactions:
          type: array
          items:
            $ref: '#/components/schemas/FiledReportTransaction'
          description: 取引の削除を妨げている取引と、それぞれの取引を記載しているレポート。
    FiledRegulatoryReport:
      type: object
      description: 要求された削除を妨げる、確定済みの規制当局向けレポート。
      required:
        - uuid
        - report_number
        - report_type
        - case_uuid
      properties:
        uuid:
          type: string
          format: uuid
          description: レポートのUUID。
        report_number:
          type: string
          description: Consoleに表示されるレポート番号（例：SAR-0001）。
        report_type:
          type: string
          enum:
            - SAR
            - STR
            - CTR
            - TTR
            - UTR
            - IFT
            - CBR
            - TFR
          description: 規制当局向けレポートの種類。
        case_uuid:
          type: string
          format: uuid
          description: レポートが属するケース。
    FiledReportTransaction:
      type: object
      description: 確定済みの規制当局向けレポートに記載されているため、削除できない取引。
      required:
        - uuid
        - transaction_id
        - reports
      properties:
        uuid:
          type: string
          format: uuid
          description: Diditの取引UUIDです。
        transaction_id:
          type: string
          description: 取引の作成時に指定された取引識別子。
        reports:
          type: array
          items:
            $ref: '#/components/schemas/FiledRegulatoryReport'
          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.