> ## 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

> Diditで対象セッションが20件を超え、Batch Delete Sessionsが202を返した一括削除について、ジョブのステータスと結果件数をポーリングで取得します。



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



      
      

\<pre>

\`Goal: Read the progress of a bulk session deletion that POST /v3/sessions/delete/ answered with 202. That happens when more than 20 KYC sessions match the request, whether they are selected by session_numbers or with delete_all.

Endpoint: GET https://verification.didit.me/v3/sessions/delete/{job_id}/
Auth header: x-api-key: <DIDIT_API_KEY>

Path param:
\- job_id: the job_id returned with the 202.

curl:
curl 'https://verification.didit.me/v3/sessions/delete/JOB_ID/' \
-H 'x-api-key: YOUR_API_KEY'

Response 200:
\{
"job_id": "<uuid>",
"status": "PROCESSING",            // PENDING | PROCESSING | COMPLETED | FAILED
"total": 250,                      // sessions selected when the deletion was requested
"processed": 100,                  // sessions the job has finished with so far
"outcomes": {"deleted": 82, "none": 18, "retained_with_user": 0, "ineligible_no_vendor_user": 0, "failed_retryable": 0, "already_deleted": 0},
"deleted_child_verifications": 0,  // always 0 for jobs from POST /v3/sessions/delete/ (KYC sessions only)
"error": null,                     // why the deletion stopped, when status is FAILED
"created_at": "<datetime>",
"completed_at": null
}

outcomes counts:
\- deleted: sessions deleted together with their face embedding.
\- none: sessions deleted that had no face embedding.
\- retained_with_user: sessions deleted while one image-free biometric template was retained for their User, as the request or the application policy asked.
\- ineligible_no_vendor_user: retention was requested but the session had no linked User; the session and its embedding were deleted.
\- failed_retryable: sessions reported as not deleted. The job retries a group it could not delete by itself instead of counting it here.
\- already_deleted: selected sessions that were already deleted, for example by another request, when the job reached them.

Polling: request the job every few seconds while status is PENDING or PROCESSING; stop at COMPLETED or FAILED. The job never lists which sessions it deleted, only counts. A FAILED job explains why in error; the sessions it had not reached are still in place, so repeat the deletion request to delete them. Deletion is permanent and irreversible.

Failure modes:
\- 403: missing x-api-key (a wrong, revoked or expired key gets 401). { "detail": "You do not have permission to perform this action." }
\- 404: no such job for this application (a job is only visible to the application that created it).

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

\</pre>



      
      

貼り付け先

## 概要[セッションの一括削除](https://docs.didit.me/ja/management-api/sessions/batch-delete.md)で開始されたセッションの一括削除について、ステータス、処理済みのセッション数、各結果となったセッション数を返します。`session_numbers`による選択または`delete_all`で一括削除の対象となるKYCセッションが20件を超える場合、リクエストは`PENDING`状態のジョブとともに`202`を返し、セッションはバックグラウンドで削除されます。`status`が`COMPLETED`または`FAILED`になるまで、このエンドポイントを数秒おきにポーリングしてください。ジョブが削除する各セッションは、[セッションの削除](https://docs.didit.me/ja/sessions-api/delete-session.md)とまったく同じ方法で削除されます。セッション、そのセッションが保持するすべての認証試行、保存されているすべてのファイルが削除され、メディアURLは解決できなくなります。削除は永続的で、元に戻すことはできません。ジョブが報告するのは件数のみです。どのセッションを削除したかが一覧で示されることはありません。## ジョブのステータス| `status` | 意味 |
| - | - |
| `PENDING` | 受け付け済みで、まだ開始されていません。 |
| `PROCESSING` | 削除中です。`processed`と`outcomes`が更新されています。 |
| `COMPLETED` | 選択されたすべてのセッションが`outcomes`に含まれています。 |
| `FAILED` | ジョブが途中で停止しました。理由は`error`に示されます。ジョブがまだ処理していなかったセッションはそのまま残っています。それらを削除するには、削除リクエストを再度送信してください。 |`delete_all`ジョブが削除するのは、リクエストより前に作成されたセッションのみです。ジョブの実行中に開始されたセッションは削除されません。## 結果の件数| `outcomes`のキー | 意味 |
| - | - |
| `deleted` | 顔エンベディングとともに削除されたセッション。 |
| `none` | 削除されたセッションのうち、顔エンベディングを持っていなかったもの。 |
| `retained_with_user` | リクエストまたはアプリケーションのポリシーの指定に従い、ユーザーの画像を含まない生体認証テンプレートを1つ保持したうえで削除されたセッション。[セッションの削除](https://docs.didit.me/ja/sessions-api/delete-session.md#顔の生体認証データ-削除または保持)を参照してください。 |
| `ineligible_no_vendor_user` | 保持が要求されたものの、セッションにリンクされたユーザーが存在しなかったもの。セッションとその顔エンベディングは削除されました。 |
| `failed_retryable` | 削除されなかったと報告されたセッション。ジョブは削除できなかったグループをここに計上せず、自動で再試行します。 |
| `already_deleted` | 選択されたセッションのうち、ジョブが処理に到達した時点で、別のリクエストなどによりすでに削除されていたもの。 |`deleted_child_verifications`は、削除された法人確認によって作成され、それとともに削除された認証の件数です。KYCセッションのみを削除する[セッションの一括削除](https://docs.didit.me/ja/management-api/sessions/batch-delete.md)で開始されたジョブでは、常に`0`になります。## 権限アプリケーションの有効なAPIキーであれば、どれでもこのエンドポイントを呼び出せます。ジョブは、それを作成したアプリケーションからのみ参照できます。それ以外の`job_id`を指定すると`404`が返されます。## 関連ページ- [セッションの一括削除](https://docs.didit.me/ja/management-api/sessions/batch-delete.md)
- [セッションの削除](https://docs.didit.me/ja/sessions-api/delete-session.md)
- [データ保持](https://docs.didit.me/ja/console/data-retention.md)


## OpenAPI

````yaml ja/openapi-25.json GET /v3/sessions/delete/{job_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/sessions/delete/{job_id}/:
    get:
      tags:
        - Sessions
      summary: セッション一括削除ジョブを取得
      description: >-
        `POST
        /v3/sessions/delete/`が`202`で応答した一括セッション削除の進捗です（`session_numbers`または`delete_all`で選択され、該当するセッションが20件を超える場合）。`status`が`PENDING`または`PROCESSING`の間は数秒ごとにポーリングし、`COMPLETED`または`FAILED`になったら停止してください。


        ジョブは、各結果に終わったセッションの件数と処理済みの件数を報告しますが、どのセッションを削除したかは報告しません。`FAILED`のジョブは`error`に理由を含みます。ジョブが処理に到達していなかったセッションはそのまま残っているため、削除リクエストを再度送信して削除してください。


        **認証：**`x-api-key`ヘッダーにAPIキーを指定します。ジョブはそれを作成したアプリケーションからのみ参照でき、それ以外の`job_id`は`404`を返します。認証情報がない、または無効な場合は`403`を返します。このAPIが`401`を返すことはありません。
      operationId: get_session_deletion_job
      parameters:
        - name: job_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: '`POST /v3/sessions/delete/`の`202`とともに返された`job_id`です。'
      responses:
        '200':
          description: ジョブです。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionDeletionJob'
              examples:
                Processing:
                  value:
                    job_id: 5b8f2c1e-7d3a-4f6b-9e2c-1a0d8f7e6c5b
                    status: PROCESSING
                    total: 250
                    processed: 100
                    outcomes:
                      deleted: 82
                      none: 18
                      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
                Completed:
                  value:
                    job_id: 5b8f2c1e-7d3a-4f6b-9e2c-1a0d8f7e6c5b
                    status: COMPLETED
                    total: 250
                    processed: 250
                    outcomes:
                      deleted: 204
                      none: 44
                      retained_with_user: 0
                      ineligible_no_vendor_user: 0
                      failed_retryable: 0
                      already_deleted: 2
                    deleted_child_verifications: 0
                    error: null
                    created_at: '2026-10-09T10:15:00Z'
                    completed_at: '2026-10-09T10:16:40Z'
                Failed:
                  value:
                    job_id: 5b8f2c1e-7d3a-4f6b-9e2c-1a0d8f7e6c5b
                    status: FAILED
                    total: 250
                    processed: 100
                    outcomes:
                      deleted: 82
                      none: 18
                      retained_with_user: 0
                      ineligible_no_vendor_user: 0
                      failed_retryable: 0
                      already_deleted: 0
                    deleted_child_verifications: 0
                    error: >-
                      The deletion stopped before it finished. The sessions it
                      had not reached are still in place; repeat the request to
                      delete them.
                    created_at: '2026-10-09T10:15:00Z'
                    completed_at: '2026-10-09T10:15:52Z'
        '403':
          description: APIキーがありません。キーがない場合は`403`を返し、誤った、失効した、または期限切れのキーの場合は`401`を返します。
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              examples:
                Missing or invalid API key:
                  summary: x-api-keyヘッダーがないか、キーが無効です
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: 呼び出し元のアプリケーションに、この`job_id`の削除ジョブは存在しません。ジョブは作成したアプリケーションからのみ参照できます。
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: |-
            curl 'https://verification.didit.me/v3/sessions/delete/JOB_ID/' \
              -H 'x-api-key: YOUR_API_KEY'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.sessions.retrieve_deletion_job(
                "11111111-2222-3333-4444-555555555555",
            )
            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.retrieveDeletionJob("11111111-2222-3333-4444-555555555555");

            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Sessions.RetrieveDeletionJob(ctx, \"11111111-2222-3333-4444-555555555555\")\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.sessions().retrieveDeletionJob("11111111-2222-3333-4444-555555555555");

            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->retrieveDeletionJob('11111111-2222-3333-4444-555555555555');

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


            # Reads DIDIT_API_KEY.

            didit = Didit::Client.new


            result =
            didit.sessions.retrieve_deletion_job("11111111-2222-3333-4444-555555555555")

            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.RetrieveDeletionJobAsync("11111111-2222-3333-4444-555555555555");

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    SessionDeletionJob:
      type: object
      description: バックグラウンドで実行中のセッション一括削除。進捗と結果ごとの件数を示しますが、どのセッションを削除したかは示しません。
      properties:
        job_id:
          type: string
          format: uuid
          description: このIDを使用して`GET /v3/sessions/delete/{job_id}/`をポーリングします。
        status:
          type: string
          enum:
            - PENDING
            - PROCESSING
            - COMPLETED
            - FAILED
          description: >-
            `PENDING`：受け付け済みで、まだ開始されていません。`PROCESSING`：削除中で、`processed`と`outcomes`が更新されています。`COMPLETED`：選択されたすべてのセッションの処理が完了しました。`FAILED`：ジョブが途中で停止しました。`error`を参照してください。
        total:
          type: integer
          description: 削除がリクエストされた時点で選択されていたセッション。
        processed:
          type: integer
          description: ジョブがこれまでに処理を完了したセッション。
        outcomes:
          type: object
          description: 各結果で終了したセッションの数。すべてのキーが常に含まれます。
          properties:
            deleted:
              type: integer
              description: 顔エンベディングとともに削除されたセッション。
            none:
              type: integer
              description: 削除されたセッションのうち、顔エンベディングがなかったもの。
            retained_with_user:
              type: integer
              description: >-
                リクエストまたはアプリケーションのポリシーの指定に従い、画像を含まない生体認証テンプレートを1つそのユーザー用に保持したうえで削除されたセッション。
            ineligible_no_vendor_user:
              type: integer
              description: 保持がリクエストされたものの、紐付けられたユーザーがいなかったため、顔エンベディングとともに削除されたセッション。
            failed_retryable:
              type: integer
              description: 削除されなかったと報告されたセッション。ジョブは自身で削除できなかったグループをここに計上せず、再試行します。
            already_deleted:
              type: integer
              description: 選択されたセッションのうち、ジョブが処理する時点で、別のリクエストなどによりすでに削除されていたセッションです。
        deleted_child_verifications:
          type: integer
          description: >-
            削除された法人確認によって作成され、それとあわせて削除された認証です。`POST
            /v3/sessions/delete/`で開始されたジョブはKYCセッションのみを削除するため、常に`0`です。
        error:
          type: string
          nullable: true
          description: >-
            通常は`null`で、`status`が`FAILED`の場合のみ削除が停止した理由が入ります。ジョブが到達していなかったセッションはそのまま残っています。それらを削除するには、リクエストを再度送信してください。
        created_at:
          type: string
          format: date-time
          description: 削除がリクエストされた日時。
        completed_at:
          type: string
          format: date-time
          nullable: true
          description: ジョブが完了した日時。実行中は`null`です。
  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.