メインコンテンツへスキップ
GET
curl

概要

セッションの一括削除で開始されたセッションの一括削除について、ステータス、処理済みのセッション数、各結果となったセッション数を返します。 session_numbersによる選択またはdelete_allで一括削除の対象となるKYCセッションが20件を超える場合、リクエストはPENDING状態のジョブとともに202を返し、セッションはバックグラウンドで削除されます。statusがCOMPLETEDまたはFAILEDになるまで、このエンドポイントを数秒おきにポーリングしてください。 ジョブが削除する各セッションは、セッションの削除とまったく同じ方法で削除されます。セッション、そのセッションが保持するすべての認証試行、保存されているすべてのファイルが削除され、メディアURLは解決できなくなります。削除は永続的で、元に戻すことはできません。 ジョブが報告するのは件数のみです。どのセッションを削除したかが一覧で示されることはありません。

ジョブのステータス

delete_allジョブが削除するのは、リクエストより前に作成されたセッションのみです。ジョブの実行中に開始されたセッションは削除されません。

結果の件数

deleted_child_verificationsは、削除された法人確認によって作成され、それとともに削除された認証の件数です。KYCセッションのみを削除するセッションの一括削除で開始されたジョブでは、常に0になります。

権限

アプリケーションの有効なAPIキーであれば、どれでもこのエンドポイントを呼び出せます。ジョブは、それを作成したアプリケーションからのみ参照できます。それ以外のjob_idを指定すると404が返されます。

関連ページ

承認

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

パスパラメータ

job_id
string<uuid>
必須

POST /v3/sessions/delete/の202とともに返されたjob_idです。

レスポンス

ジョブです。

バックグラウンドで実行中のセッション一括削除。進捗と結果ごとの件数を示しますが、どのセッションを削除したかは示しません。

job_id
string<uuid>

このIDを使用してGET /v3/sessions/delete/{job_id}/をポーリングします。

status
enum<string>

PENDING:受け付け済みで、まだ開始されていません。PROCESSING:削除中で、processedとoutcomesが更新されています。COMPLETED:選択されたすべてのセッションの処理が完了しました。FAILED:ジョブが途中で停止しました。errorを参照してください。

利用可能なオプション:
PENDING,
PROCESSING,
COMPLETED,
FAILED
total
integer

削除がリクエストされた時点で選択されていたセッション。

processed
integer

ジョブがこれまでに処理を完了したセッション。

outcomes
object

各結果で終了したセッションの数。すべてのキーが常に含まれます。

deleted_child_verifications
integer

削除された法人確認によって作成され、それとあわせて削除された認証です。POST /v3/sessions/delete/で開始されたジョブはKYCセッションのみを削除するため、常に0です。

error
string | null

通常はnullで、statusがFAILEDの場合のみ削除が停止した理由が入ります。ジョブが到達していなかったセッションはそのまま残っています。それらを削除するには、リクエストを再度送信してください。

created_at
string<date-time>

削除がリクエストされた日時。

completed_at
string<date-time> | null

ジョブが完了した日時。実行中はnullです。

最終更新日 2026年11月1日