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

# Consultar job de exclusão de sessões via API

> Consulte na API do Didit o status e as contagens de um job de exclusão em lote de sessões, retornado com 202 quando mais de 20 sessões correspondem.



Prompt para consultar o job de exclusão de sessões
        Copiar o prompt para a área de transferência



      
      

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



      
      

Colar em

## Visão geralRetorna uma exclusão em massa de sessões iniciada por [Excluir sessões em lote](https://docs.didit.me/pt-br/management-api/sessions/batch-delete.md): o status, quantas sessões já foram processadas e quantas terminaram em cada resultado.Quando mais de 20 sessões de KYC correspondem a uma exclusão em lote, selecionadas por `session_numbers` ou com `delete_all`, a requisição retorna `202` com um job `PENDING` e as sessões são excluídas em segundo plano. Consulte este endpoint a cada poucos segundos até que `status` seja `COMPLETED` ou `FAILED`.Cada sessão que o job exclui é excluída exatamente como em [Excluir sessão](https://docs.didit.me/pt-br/sessions-api/delete-session.md): a sessão, todas as tentativas de verificação que ela contém e todos os seus arquivos armazenados são excluídos, e as URLs de mídia deixam de funcionar. A exclusão é permanente e irreversível.O job informa apenas contagens. Ele nunca lista quais sessões excluiu.## Status do job| `status` | Significado |
| - | - |
| `PENDING` | Aceito, ainda não iniciado. |
| `PROCESSING` | Excluindo; `processed` e `outcomes` estão sendo atualizados. |
| `COMPLETED` | Todas as sessões selecionadas estão contabilizadas em `outcomes`. |
| `FAILED` | O job parou antes do fim e `error` informa o motivo. As sessões que ele ainda não havia processado continuam existindo: repita a requisição de exclusão para excluí-las. |Um job `delete_all` exclui apenas as sessões criadas antes da requisição. Sessões iniciadas enquanto ele é executado não são excluídas.## Contagens de resultados| Chave de `outcomes` | Significado |
| - | - |
| `deleted` | Sessões excluídas junto com o embedding facial. |
| `none` | Sessões excluídas que não tinham embedding facial. |
| `retained_with_user` | Sessões excluídas mantendo um template biométrico sem imagem para o respectivo usuário, conforme solicitado pela requisição ou pela política da aplicação. Veja [Excluir sessão](https://docs.didit.me/pt-br/sessions-api/delete-session.md#dados-biométricos-faciais-excluir-ou-reter). |
| `ineligible_no_vendor_user` | A retenção foi solicitada, mas a sessão não tinha usuário vinculado. A sessão e o embedding facial foram excluídos. |
| `failed_retryable` | Sessões informadas como não excluídas. Quando não consegue excluir um grupo, o job tenta novamente por conta própria em vez de contabilizá-lo aqui. |
| `already_deleted` | Sessões selecionadas que já estavam excluídas quando o job as alcançou, por exemplo por outra requisição. |`deleted_child_verifications` conta as verificações criadas por verificações de empresas excluídas e que foram excluídas junto com elas. O valor é sempre `0` para um job iniciado por [Excluir sessões em lote](https://docs.didit.me/pt-br/management-api/sessions/batch-delete.md), que exclui apenas sessões de KYC.## PermissõesQualquer chave de API ativa da aplicação pode chamar este endpoint. Um job só fica visível para a aplicação que o criou; qualquer outro `job_id` retorna `404`.## Relacionados- [Excluir sessões em lote](https://docs.didit.me/pt-br/management-api/sessions/batch-delete.md)
- [Excluir sessão](https://docs.didit.me/pt-br/sessions-api/delete-session.md)
- [Retenção de dados](https://docs.didit.me/pt-br/console/data-retention.md)


## OpenAPI

````yaml pt-br/openapi-25.json GET /v3/sessions/delete/{job_id}/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: API de verificação de identidade. Autentique-se com o cabeçalho x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/sessions/delete/{job_id}/:
    get:
      tags:
        - Sessions
      summary: Obter um job de exclusão de sessões em massa
      description: >-
        Progresso de uma exclusão de sessões em massa à qual `POST
        /v3/sessions/delete/` respondeu com `202` (mais de 20 sessões
        correspondentes, selecionadas por `session_numbers` ou com
        `delete_all`). Consulte a cada poucos segundos enquanto `status` for
        `PENDING` ou `PROCESSING`; pare quando for `COMPLETED` ou `FAILED`.


        O job informa quantas sessões terminaram em cada resultado e quantas já
        processou, mas nunca quais sessões excluiu. Um job `FAILED` traz o
        motivo em `error`; as sessões que ele não chegou a processar continuam
        existindo, então repita a requisição de exclusão para excluí-las.


        **Autenticação:** chave de API no cabeçalho `x-api-key`. Um job só fica
        visível para a aplicação que o criou; qualquer outro `job_id` retorna
        `404`. Credenciais ausentes ou inválidas retornam `403`; esta API nunca
        retorna `401`.
      operationId: get_session_deletion_job
      parameters:
        - name: job_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: O `job_id` retornado com o `202` de `POST /v3/sessions/delete/`.
      responses:
        '200':
          description: A tarefa.
          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: >-
            Chave de API ausente. Uma chave ausente retorna `403`; uma chave
            incorreta, revogada ou expirada retorna `401`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              examples:
                Missing or invalid API key:
                  summary: Cabeçalho x-api-key ausente, ou a chave é inválida
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: >-
            Não existe nenhum job de exclusão com este `job_id` para a aplicação
            que fez a chamada. Os jobs só são visíveis para a aplicação que os
            criou.
      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: >-
        Uma exclusão de sessões em massa executada em segundo plano: progresso e
        contagens por resultado, nunca quais sessões ela excluiu.
      properties:
        job_id:
          type: string
          format: uuid
          description: >-
            Consulte `GET /v3/sessions/delete/{job_id}/` periodicamente com este
            id.
        status:
          type: string
          enum:
            - PENDING
            - PROCESSING
            - COMPLETED
            - FAILED
          description: >-
            `PENDING`: aceito, ainda não iniciado. `PROCESSING`: excluindo;
            `processed` e `outcomes` estão sendo atualizados. `COMPLETED`: todas
            as sessões selecionadas foram contabilizadas. `FAILED`: o job parou
            antes do fim; consulte `error`.
        total:
          type: integer
          description: Sessões selecionadas quando a exclusão foi solicitada.
        processed:
          type: integer
          description: Sessões que o job já concluiu até agora.
        outcomes:
          type: object
          description: >-
            Quantas sessões terminaram em cada resultado. Todas as chaves estão
            sempre presentes.
          properties:
            deleted:
              type: integer
              description: Sessões excluídas junto com o respectivo embedding facial.
            none:
              type: integer
              description: Sessões excluídas que não tinham embedding facial.
            retained_with_user:
              type: integer
              description: >-
                Sessões excluídas mantendo um template biométrico sem imagem
                para o respectivo User, conforme solicitado pela requisição ou
                pela política da aplicação.
            ineligible_no_vendor_user:
              type: integer
              description: >-
                Sessões excluídas, com o respectivo embedding facial, porque a
                retenção foi solicitada, mas elas não tinham User vinculado.
            failed_retryable:
              type: integer
              description: >-
                Sessões informadas como não excluídas. Um job tenta novamente,
                por conta própria, excluir um grupo que não conseguiu excluir,
                em vez de contabilizá-lo aqui.
            already_deleted:
              type: integer
              description: >-
                Sessões selecionadas que já tinham sido excluídas, por exemplo
                por outra requisição, quando o job chegou a elas.
        deleted_child_verifications:
          type: integer
          description: >-
            Verificações criadas pelas verificações de empresas excluídas, que
            foram excluídas junto com elas. Sempre `0` para um job iniciado por
            `POST /v3/sessions/delete/`, que exclui apenas sessões de KYC.
        error:
          type: string
          nullable: true
          description: >-
            `null`, a menos que `status` seja `FAILED`; nesse caso, o motivo
            pelo qual a exclusão parou. As sessões que o job ainda não havia
            alcançado continuam existindo: repita a requisição para excluí-las.
        created_at:
          type: string
          format: date-time
          description: Quando a exclusão foi solicitada.
        completed_at:
          type: string
          format: date-time
          nullable: true
          description: Quando o job terminou; `null` enquanto está em execução.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Chave de API da sua aplicação, em Developers -> API keys no Business
        Console. A chave principal tem acesso total. Uma chave nomeada pode ter
        escopo restrito: nenhum acesso, leitura ou escrita por recurso, limitada
        a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a
        uma data de validade. 401 significa que a chave está errada, revogada ou
        expirada; 403 significa que nenhuma chave foi enviada, que a chave não
        tem acesso a este recurso ou ação, ou que a requisição veio de um
        endereço fora da sua lista de IPs; 404 em uma rota de sessão significa
        que a sessão está fora dos fluxos ou status da chave. Uma chave sem
        acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave
        sem permissão de escrita em sessões recebe links e tokens de sessão como
        null. Consulte https://docs.didit.me/console/api-keys.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.