セッション一括削除API：KYCセッションの整理

curl

curl -X POST \
  https://verification.didit.me/v3/sessions/delete/ \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "session_numbers": ["1001", "1002", "1003"]
  }'

import Didit from "@didit-protocol/sdk-node";

// Reads DIDIT_API_KEY.
const didit = new Didit();

const result = await didit.sessions.batchDelete({
  session_numbers: ["1001", "1002", "1003"],
});
console.log(result);

ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

result, err := client.Sessions.BatchDelete(ctx, didit.SessionsBatchDeleteParams{
	SessionNumbers: didit.Some([]string{"1001", "1002", "1003"}),
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)

import java.util.List;
import me.didit.Didit;
import me.didit.types.SessionsBatchDeleteParams;

// Reads DIDIT_API_KEY.
Didit client = new Didit();

var result = client.sessions().batchDelete(SessionsBatchDeleteParams.builder()
        .sessionNumbers(List.of("1001", "1002", "1003"))
        .build());
System.out.println(result);

<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

// Reads DIDIT_API_KEY.
$didit = new DiditClient();

$result = $didit->sessions->batchDelete([
    'session_numbers' => ['1001', '1002', '1003'],
]);
print_r($result->toArray());

using System;
using System.Text.Json;
using Didit;

// Reads DIDIT_API_KEY.
using var client = new DiditClient();

var result = await client.Sessions.BatchDeleteAsync(new SessionsBatchDeleteParams
{
    SessionNumbers = new string[] { "1001", "1002", "1003" },
});
Console.WriteLine(JsonSerializer.Serialize(result));

{
  "results": [
    {
      "session_id": "4c5c7f3a-3b1d-4b7e-9c39-2b4f7e6a1d02",
      "session_number": 1001,
      "face_retention_outcome": "deleted",
      "biometric_template_uuid": null,
      "biometric_template_expires_at": null,
      "deleted_child_verifications": 0
    },
    {
      "session_id": "b8e1d2c3-4f5a-4b6c-8d7e-9f0a1b2c3d4e",
      "session_number": 1002,
      "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": "7a1e9c2d-5f4b-4c3a-8e2d-1b0a9f8e7d6c",
      "session_number": 1003,
      "face_retention_outcome": "ineligible_no_vendor_user",
      "biometric_template_uuid": null,
      "biometric_template_expires_at": null,
      "deleted_child_verifications": 0
    },
    {
      "session_id": "c1d2e3f4-a5b6-4c7d-8e9f-0a1b2c3d4e5f",
      "session_number": 1004,
      "face_retention_outcome": "failed_retryable",
      "biometric_template_uuid": null,
      "biometric_template_expires_at": null,
      "deleted_child_verifications": 0
    }
  ]
}

POST

sessions

delete

curl

curl -X POST \
  https://verification.didit.me/v3/sessions/delete/ \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "session_numbers": ["1001", "1002", "1003"]
  }'

import Didit from "@didit-protocol/sdk-node";

// Reads DIDIT_API_KEY.
const didit = new Didit();

const result = await didit.sessions.batchDelete({
  session_numbers: ["1001", "1002", "1003"],
});
console.log(result);

ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

result, err := client.Sessions.BatchDelete(ctx, didit.SessionsBatchDeleteParams{
	SessionNumbers: didit.Some([]string{"1001", "1002", "1003"}),
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)

import java.util.List;
import me.didit.Didit;
import me.didit.types.SessionsBatchDeleteParams;

// Reads DIDIT_API_KEY.
Didit client = new Didit();

var result = client.sessions().batchDelete(SessionsBatchDeleteParams.builder()
        .sessionNumbers(List.of("1001", "1002", "1003"))
        .build());
System.out.println(result);

<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

// Reads DIDIT_API_KEY.
$didit = new DiditClient();

$result = $didit->sessions->batchDelete([
    'session_numbers' => ['1001', '1002', '1003'],
]);
print_r($result->toArray());

using System;
using System.Text.Json;
using Didit;

// Reads DIDIT_API_KEY.
using var client = new DiditClient();

var result = await client.Sessions.BatchDeleteAsync(new SessionsBatchDeleteParams
{
    SessionNumbers = new string[] { "1001", "1002", "1003" },
});
Console.WriteLine(JsonSerializer.Serialize(result));

{
  "results": [
    {
      "session_id": "4c5c7f3a-3b1d-4b7e-9c39-2b4f7e6a1d02",
      "session_number": 1001,
      "face_retention_outcome": "deleted",
      "biometric_template_uuid": null,
      "biometric_template_expires_at": null,
      "deleted_child_verifications": 0
    },
    {
      "session_id": "b8e1d2c3-4f5a-4b6c-8d7e-9f0a1b2c3d4e",
      "session_number": 1002,
      "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": "7a1e9c2d-5f4b-4c3a-8e2d-1b0a9f8e7d6c",
      "session_number": 1003,
      "face_retention_outcome": "ineligible_no_vendor_user",
      "biometric_template_uuid": null,
      "biometric_template_expires_at": null,
      "deleted_child_verifications": 0
    },
    {
      "session_id": "c1d2e3f4-a5b6-4c7d-8e9f-0a1b2c3d4e5f",
      "session_number": 1004,
      "face_retention_outcome": "failed_retryable",
      "biometric_template_uuid": null,
      "biometric_template_expires_at": null,
      "deleted_child_verifications": 0
    }
  ]
}

動作

一致した各セッションは、セッションの削除とまったく同じ方法で削除されます。セッション、そのセッションが保持するすべての認証試行、判定と抽出データ、機能レコード、保存されているすべてのファイルが削除され、セッションはすべての読み取りエンドポイントから表示されなくなり、発行済みのメディアURLは解決できなくなります。削除されたセッションについてキューに残っているWebhookの配信とその再試行は破棄されます。配信済みのWebhookには影響しません。削除は永続的であり、元に戻すことはできません。選択したセッションのいずれかが確定済みの規制当局向けレポートに含まれている場合、リクエスト全体が409を返し、何も削除されません。レスポンスにはcode: in_filed_reportが含まれ、該当する各レポートが示されます。レポートの削除で各レポートを削除してから、リクエストを再度実行してください。レポートを削除してもセッションは削除されません。このリクエストを再度実行するまで、セッションは残ります。 session_numbersとdelete_allのどちらで選択した場合でも、一致するセッションの件数によってリクエストへの応答方法が決まります。

一致するセッション	レスポンス
20件以下	削除完了後に`200 OK`を返し、`results`には一致したセッションごとに1件の結果が含まれます。
20件超	削除ジョブとともに`202 Accepted`を返します。セッションはバックグラウンドで削除されます。完了するまでセッション削除ジョブの取得をポーリングしてください。

結果はセッションが削除されたことを示しますが、face_retention_outcomeがfailed_retryableの場合は例外です。そのセッションは削除されておらず、そのまま残っています。そのため、この結果は再試行すべき失敗として扱い、決して削除の確認として扱わないでください。アプリケーション内の現在存在するKYCセッションに一致しない番号はスキップされ、resultsには含まれません。

フィルターによる`delete_all`の絞り込み

delete_all: trueを指定すると、セッションの一覧取得のフィルターにfilter_を接頭辞として付けて、選択対象を絞り込めます。これらのフィルターには、クエリパラメーターと同じ値を指定します。複数の値を受け付けるフィルター(status、workflow_id、country、region、document_type、document_name、session_type、warning、organization_name)には、カンマ区切りの文字列または配列を指定できます。

{
  "delete_all": true,
  "filter_status": ["Declined"],
  "filter_workflow_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "filter_date_from": "2026-09-01",
  "filter_date_to": "2026-09-30"
}

フィルターはdelete_allと組み合わせた場合にのみ適用されます。session_numbersと組み合わせた場合、フィルターは検証されますが、選択対象は変わりません。
その他のフィルターはすべて1つの値のみを受け付けます。配列はカンマ区切りの1つの値に結合されるため、複数の日付、UUID、api_serviceの値を指定すると400が返され、複数のvendor_data、search、screened_full_nameのテキストは、いずれかに一致すればよい条件としては照合されません。
値が空のフィルターは無視されるため、選択対象は絞り込まれません。
不明なfilter_*キーを指定すると400 {"filter_reviewer": "Unknown filter."}が返され、解釈できない値を指定すると、{"filter_date_from": ["Enter a valid date."]}のように400が返され、そのレスポンスは該当するfilter_*キーをキーとします。いずれの場合も何も削除されないため、フィルターの入力ミスによって削除対象がすべてのセッションに広がることはありません。
削除ジョブにも同じフィルターが適用され、他のすべてのdelete_allと同様に、リクエストより前に作成されたセッションのみが対象となります。

保持および指示のフィールド

このエンドポイントは、単一セッションのエンドポイントと同じ任意のフィールドを受け付け、一致したすべてのセッションに適用します。

フィールド	型	説明
`retain_face_embeddings`	booleanまたはnull	このリクエストについて、アプリケーションの`face_retention_policy`を上書きします。
`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です。監査証跡と保持されるすべてのテンプレートに記録されます。

保持されるテンプレートに含まれるものと含まれないもの、expires_atの算出方法、プライバシー消去の指示の動作については、セッションの削除を参照してください。

セッションごとの結果

最大20件の一致するセッションについて、200 OKはセッションごとに1件の結果を返します。

{
  "results": [
    { "session_id": "4c5c7f3a-3b1d-4b7e-9c39-2b4f7e6a1d02", "session_number": 1001, "face_retention_outcome": "deleted", "biometric_template_uuid": null, "biometric_template_expires_at": null, "deleted_child_verifications": 0 },
    { "session_id": "b8e1d2c3-4f5a-4b6c-8d7e-9f0a1b2c3d4e", "session_number": 1002, "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": "7a1e9c2d-5f4b-4c3a-8e2d-1b0a9f8e7d6c", "session_number": 1003, "face_retention_outcome": "ineligible_no_vendor_user", "biometric_template_uuid": null, "biometric_template_expires_at": null, "deleted_child_verifications": 0 },
    { "session_id": "c1d2e3f4-a5b6-4c7d-8e9f-0a1b2c3d4e5f", "session_number": 1004, "face_retention_outcome": "failed_retryable", "biometric_template_uuid": null, "biometric_template_expires_at": null, "deleted_child_verifications": 0 }
  ]
}

各結果には、セッションの削除のレスポンスと同じフィールドが含まれます。biometric_template_expires_atは保持されたテンプレートが削除される日時です。このエンドポイントはKYCセッションのみを削除するため、ここではdeleted_child_verificationsは常に0です。

`face_retention_outcome`	意味
`deleted`	セッションとその顔エンベディングが削除されます。デフォルトの動作です。
`retained_with_user`	セッションは削除されます。画像を含まない生体認証テンプレートが1件、ユーザーに紐付いて残ります。そのIDは`biometric_template_uuid`です。
`none`	セッションには、削除または保持する顔エンベディングがありませんでした。
`ineligible_no_vendor_user`	保持がリクエストされましたが、セッションがユーザーに紐付いていないため、テンプレートを紐付ける先がありません。セッションとそのエンベディングは削除されます。
`failed_retryable`	ストレージサービス、生体認証ストア、またはモニタリングプロバイダーが利用できなかったため、このセッションを含むグループを削除できませんでした。このセッションは削除されておらず、そのまま残っています。このセッションについてリクエストを再実行してください。再試行しても、テンプレートは1件に集約されます。

セッションはグループ単位で削除されます。グループを削除できなかった場合、そのグループ内のすべてのセッションがfailed_retryableとして報告されます。他のグループには影響せず、削除された状態のままです。

多数のセッションを選択した場合はジョブとして実行されます

20件を超えるセッションが一致する場合、レスポンスはresultsではなく、削除ジョブを含む202 Acceptedになります。

{
  "job_id": "5b8f2c1e-7d3a-4f6b-9e2c-1a0d8f7e6c5b",
  "status": "PENDING",
  "total": 250,
  "processed": 0,
  "outcomes": { "deleted": 0, "none": 0, "retained_with_user": 0, "ineligible_no_vendor_user": 0, "failed_retryable": 0, "already_deleted": 0 },
  "deleted_child_verifications": 0,
  "error": null,
  "created_at": "2026-10-09T10:15:00Z",
  "completed_at": null
}

statusがCOMPLETEDまたはFAILEDになるまで、数秒ごとにセッション削除ジョブの取得をポーリングしてください。

ジョブは結果ごとのセッション件数を報告しますが、どのセッションを削除したかは報告しません。
delete_allジョブは、リクエストより前に作成されたセッションのみを削除します。ジョブの実行中に開始されたセッションは削除されません。
リクエストの保持フィールドと指示フィールドは、ジョブが削除するすべてのセッションに適用されます。
グループをまだ削除できない場合、ジョブはそのグループを自動的に再試行します。
FAILEDになったジョブは、その理由をerrorで示します。ジョブがまだ処理していないセッションはそのまま残っているため、リクエストを再度送信して削除してください。

例

セッション番号で削除
削除してテンプレートを保持
プライバシー消去
すべて削除してジョブをポーリング

curl -X POST https://verification.didit.me/v3/sessions/delete/ \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"session_numbers": ["1001", "1002", "1003"]}'

curl -X POST https://verification.didit.me/v3/sessions/delete/ \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "session_numbers": ["1001", "1002"],
    "retain_face_embeddings": true,
    "face_retention_days": 365,
    "instruction_id": "post-approval-cleanup-2026-08"
  }'

curl -X POST https://verification.didit.me/v3/sessions/delete/ \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "session_numbers": ["1001"],
    "deletion_instruction": "privacy_erasure",
    "instruction_id": "dsar-2026-0142"
  }'

curl -X POST https://verification.didit.me/v3/sessions/delete/ \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"delete_all": true}'

# More than 20 sessions matched: the response is 202 with a job_id.
curl https://verification.didit.me/v3/sessions/delete/JOB_ID/ \
  -H "x-api-key: YOUR_API_KEY"

204レスポンスからの移行

今回のリリースまで、このエンドポイントは204 No Contentを返していました。現在は、results[]を含む200 OKを返すか、一致するセッションが20件を超える場合は削除ジョブを含む202 Acceptedを返します。204を前提としているクライアントは更新してください。デフォルトの削除動作は変わりません。既存のアプリケーションでは、ポリシーを明示的に変更するまでdelete_with_sessionが適用されます。

関連ページ

承認

x-api-key

string

header

必須

お客様のアプリケーションのAPIキーです。Business ConsoleのDevelopers -> API keysで取得できます。プライマリキーはフルアクセス権を持ちます。名前付きキーにはスコープを設定できます。リソースごとのアクセス権（なし、読み取り、書き込み）、一部のワークフローまたは承認済みセッションへの限定、IPアドレスのリストへの限定、有効期限の設定です。401は、キーが誤っている、失効している、または期限切れであることを意味します。403は、キーが送信されていない、キーにこのリソースやアクションへのアクセス権がない、またはIPリスト外のアドレスからリクエストが送信されたことを意味します。セッションのルートでの404は、セッションがキーのワークフローまたはステータスの対象外であることを意味します。メディアへのアクセス権がないキーでは、画像、動画、PDFのURLがnullで返されます。セッションの書き込み権限がないキーでは、セッションのリンクとトークンがnullで返されます。詳細は次を参照してください: https://docs.didit.me/console/api-keys

ボディ

application/json

session_numbers

string[]

削除するKYCセッションの数値のsession_numberの値で、数字のみの文字列で指定します（JSONの数値も受け付けられ、変換されます）。delete_allがtrueでない限り必須で、空のリストは400を返します。数字以外の要素が1つでもあるとリクエスト全体が400で拒否されます（delete_allがtrueの場合は検証がスキップされ、要素は無視されます）。アプリケーション内の有効なセッションに一致しない番号は通知なくスキップされます。

Minimum array length: 1

Pattern: ^[0-9]+$

例:

["1001", "1002", "1003"]

delete_all

boolean

デフォルト:false

trueの場合、呼び出し元アプリケーションに残っているすべてのKYCセッションが削除され、session_numbersは無視されます。ただし、filter_*キーで対象を絞り込んだ場合は除きます。該当するセッションが20件を超える場合は削除ジョブ（202）として実行され、リクエストより前に作成されたセッションのみが対象になります。デフォルトはfalseです。元に戻すことはできず、確認ステップもありません。

例:

false

retain_face_embeddings

boolean | null

この削除について、アプリケーションのface_retention_policyを上書きします。trueの場合、セッションの削除後も、画像を含まない顔の生体認証テンプレートを1つ、セッションのユーザーに紐付けて保持します。falseの場合、顔エンベディングはセッションとともに削除されます。省略するかnullにすると、アプリケーションのポリシーに従います。KYBセッション、および顔エンベディングのないセッションでは無視されます。

例:

true

face_retention_days

integer

保持されるテンプレートの有限の保持期間（日数）です。テンプレートを保持する場合は必須です。ただし、アプリケーションですでにface_retention_daysが設定されている場合を除きます。テンプレートのexpires_atは、この期間、アプリケーションの一般的なデータ保持期間、face_retention_deadlineのうち最も早いものになります。

必須範囲: 1 <= x <= 3650

例:

365

face_retention_deadline

string<date-time>

保持されるテンプレートの任意の強制有効期限です。未来の日時である必要があります。

例:

"2027-08-28T00:00:00Z"

deletion_instruction

enum<string>

デフォルト:operational_session_delete

指示の種類。operational_session_deleteはセッションを削除し、ポリシーまたはretain_face_embeddingsで指定されている場合にのみテンプレートを保持します。privacy_erasureは、セッションのユーザーに紐づく保持済みの生体認証テンプレートをすべて完全に削除してからセッションを削除します。アプリケーションのポリシーで上書きすることはできず、retain_face_embeddings: trueと組み合わせることもできません（400）。

利用可能なオプション:

operational_session_delete,

privacy_erasure

例:

"operational_session_delete"

instruction_id

string

この削除指示に対するお客様の永続的な参照ID（例: 消去チケットのID）です。監査証跡と、保持されるテンプレートに記録されます。省略した場合はDiditが生成します。

Maximum string length: 255

例:

"dsar-2026-0142"

filter_status

delete_allの対象を、List Sessionsのstatusフィルターに同じ値で一致するセッションに絞り込みます。カンマ区切りの文字列または配列で指定します。delete_allを指定しない場合は無視されます。空の値は無視され、選択範囲は絞り込まれません。

filter_vendor_data

string

delete_allの対象を、List Sessionsのvendor_dataフィルターに同じ値で一致するセッションに絞り込みます。リストではなく1つの値です。配列は1つのカンマ区切りテキストに結合されるため、複数の値がそれぞれの候補として照合されることはありません。delete_allを指定しない場合は無視されます。空の値は無視され、選択範囲は絞り込まれません。

filter_search

string

delete_allの対象を、List Sessionsのsearchフィルターに同じ値で一致するセッションに絞り込みます。リストではなく1つの値です。配列は1つのカンマ区切りテキストに結合されるため、複数の値がそれぞれの候補として照合されることはありません。delete_allを指定しない場合は無視されます。空の値は無視され、選択範囲は絞り込まれません。

filter_workflow_id

delete_allの対象を、List Sessionsのworkflow_idフィルターに同じ値で一致するセッションに絞り込みます。カンマ区切りの文字列または配列で指定します。delete_allを指定しない場合は無視されます。空の値は無視され、選択範囲は絞り込まれません。

filter_date_from

string<date>

delete_allの対象を、List Sessionsのdate_fromフィルターに同じ値で一致するセッションに絞り込みます。値は1つで、リストではありません。配列は1つのカンマ区切りの値に結合されるため、複数の値は400で拒否されます。delete_allがない場合は無視されます。空の値は無視され、選択範囲は絞り込まれません。

filter_date_to

string<date>

delete_allの対象を、List Sessionsのdate_toフィルターに同じ値で一致するセッションに絞り込みます。値は1つで、リストではありません。配列は1つのカンマ区切りの値に結合されるため、複数の値は400で拒否されます。delete_allがない場合は無視されます。空の値は無視され、選択範囲は絞り込まれません。

filter_country

delete_allの対象を、List Sessionsのcountryフィルターに同じ値で一致するセッションに絞り込みます。カンマ区切りの文字列または配列で指定します。delete_allがない場合は無視されます。空の値は無視され、選択範囲は絞り込まれません。

filter_document_type

delete_allの対象を、List Sessionsのdocument_typeフィルターに同じ値で一致するセッションに絞り込みます。カンマ区切りの文字列または配列で指定します。delete_allがない場合は無視されます。空の値は無視され、選択範囲は絞り込まれません。

filter_document_name

delete_allの対象を、List Sessionsのdocument_nameフィルターに同じ値で一致するセッションに絞り込みます。カンマ区切りの文字列または配列で指定します。delete_allがない場合は無視されます。空の値は無視され、選択範囲は絞り込まれません。

filter_region

delete_allの対象を、List Sessionsのregionフィルターに同じ値で一致するセッションに絞り込みます。カンマ区切りの文字列または配列で指定します。delete_allを指定しない場合は無視されます。空の値は無視され、選択範囲は絞り込まれません。

filter_didit_internal_id

string<uuid>

delete_allの対象を、List Sessionsのdidit_internal_idフィルターに同じ値で一致するセッションに絞り込みます。値は1つで、リストではありません。配列は1つのカンマ区切りの値に結合されるため、複数の値は400で拒否されます。delete_allがない場合は無視されます。空の値は無視され、選択範囲は絞り込まれません。

filter_session_type

delete_allの対象を、List Sessionsのsession_typeフィルターに同じ値で一致するセッションに絞り込みます。カンマ区切りの文字列または配列で指定します。delete_allを指定しない場合は無視されます。空の値は無視され、選択範囲は絞り込まれません。

filter_api_service

string

delete_allの対象を、List Sessionsのapi_serviceフィルターに同じ値で一致するセッションに絞り込みます。値は1つで、リストではありません。配列は1つのカンマ区切りの値に結合されるため、複数の値は400で拒否されます。delete_allがない場合は無視されます。空の値は無視され、選択範囲は絞り込まれません。

filter_screened_full_name

string

delete_allの対象を、List Sessionsのscreened_full_nameフィルターに同じ値で一致するセッションに絞り込みます。リストではなく1つの値です。配列は1つのカンマ区切りテキストに結合されるため、複数の値がそれぞれの候補として照合されることはありません。delete_allを指定しない場合は無視されます。空の値は無視され、選択範囲は絞り込まれません。

filter_warning

delete_allの対象を、List Sessionsのwarningフィルターに同じ値で一致するセッションに絞り込みます。カンマ区切りの文字列または配列で指定します。delete_allを指定しない場合は無視されます。空の値は無視され、選択範囲は絞り込まれません。

filter_status_initialized_as_in_review

boolean

delete_allの対象を、List Sessionsのstatus_initialized_as_in_reviewフィルターに同じ値で一致するセッションに絞り込みます。delete_allを指定しない場合は無視されます。空の値は無視され、選択範囲は絞り込まれません。

filter_is_kyc_to_be_reviewed

boolean

delete_allの対象を、List Sessionsのis_kyc_to_be_reviewedフィルターに同じ値で一致するセッションに絞り込みます。delete_allがない場合は無視されます。空の値は無視され、選択範囲は絞り込まれません。

filter_euuid

string<uuid>

delete_allの対象を、List Sessionsのeuuidフィルターに同じ値で一致するセッションに絞り込みます。値は1つで、リストではありません。配列は1つのカンマ区切りの値に結合されるため、複数の値は400で拒否されます。delete_allがない場合は無視されます。空の値は無視され、選択範囲は絞り込まれません。

filter_organization_name

delete_allの対象を、List Sessionsのorganization_nameフィルターに同じ値で一致するセッションに絞り込みます。カンマ区切りの文字列または配列で指定します。APIキーを使用する場合は自組織の名前にしか一致しないため、すべてのセッションが選択されるか、1件も選択されないかのいずれかになります。delete_allを指定しない場合は無視されます。空の値は無視され、選択範囲は絞り込まれません。

レスポンス

最大20件のセッションが一致し、リクエスト内で処理されました。一致したセッションごとに1件の結果が返ります。何にも一致しなかった番号（不明または削除済み）はスキップされ、結果に含まれません。結果は削除の完了を示しますが、face_retention_outcomeがfailed_retryableの場合は例外です。そのセッションは削除されておらず、再試行する必要があります。

results

object[]

Show child attributes

最終更新日 2026年11月1日

​動作

​フィルターによるdelete_allの絞り込み

​保持および指示のフィールド

​セッションごとの結果

​多数のセッションを選択した場合はジョブとして実行されます

​例

​204レスポンスからの移行

​関連ページ

承認

ボディ

レスポンス

動作

フィルターによる`delete_all`の絞り込み

保持および指示のフィールド

セッションごとの結果

多数のセッションを選択した場合はジョブとして実行されます

例

204レスポンスからの移行

関連ページ