> ## 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 tarefa de eliminação de sessões API > Consulte o estado e as contagens de uma eliminação em massa de sessões na Didit, devolvida com 202 quando mais de 20 sessões correspondem. Prompt para obter a tarefa de eliminação de sessões Copiar o prompt para a área de transferência \

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

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": "",
"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": "",
"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.`

\
Colar em ## Visão geralDevolve uma eliminação de sessões em massa iniciada por [Eliminar sessões em lote](https://docs.didit.me/pt/management-api/sessions/batch-delete.md): o respetivo estado, quantas sessões já foram processadas e quantas terminaram em cada resultado.Quando mais de 20 sessões KYC correspondem a uma eliminação em lote, selecionadas através de `session_numbers` ou com `delete_all`, o pedido devolve `202` com uma tarefa `PENDING`, e as sessões são eliminadas em segundo plano. Consulte este endpoint a cada poucos segundos até que `status` seja `COMPLETED` ou `FAILED`.Cada sessão eliminada pela tarefa é eliminada exatamente como em [Eliminar sessão](https://docs.didit.me/pt/sessions-api/delete-session.md): a sessão, todas as tentativas de verificação que contém e todos os ficheiros armazenados são eliminados, e os respetivos URLs de multimédia deixam de ser resolvidos. A eliminação é permanente e irreversível.A tarefa comunica apenas contagens. Nunca indica quais as sessões que eliminou.## Estado da tarefa| `status` | Significado | | - | - | | `PENDING` | Aceite, ainda não iniciada. | | `PROCESSING` | A eliminar; `processed` e `outcomes` estão a ser atualizados. | | `COMPLETED` | Cada sessão selecionada está contabilizada em `outcomes`. | | `FAILED` | A tarefa parou antes do fim e `error` indica o motivo. As sessões que não chegou a processar continuam no lugar: repita o pedido de eliminação para as eliminar. |Uma tarefa `delete_all` elimina apenas as sessões criadas antes do pedido. As sessões iniciadas enquanto a tarefa está em execução não são eliminadas.## Contagens por resultado| Chave de `outcomes` | Significado | | - | - | | `deleted` | Sessões eliminadas juntamente com o respetivo embedding facial. | | `none` | Sessões eliminadas que não tinham embedding facial. | | `retained_with_user` | Sessões eliminadas enquanto um template biométrico sem imagem foi retido para o respetivo utilizador, conforme especificado no pedido ou na política da aplicação. Consulte [Eliminar sessão](https://docs.didit.me/pt/sessions-api/delete-session.md#dados-biométricos-faciais-eliminar-ou-conservar). | | `ineligible_no_vendor_user` | Foi pedida a retenção, mas a sessão não tinha um utilizador associado. A sessão e o respetivo embedding facial foram eliminados. | | `failed_retryable` | Sessões comunicadas como não eliminadas. A tarefa volta a tentar um grupo que não conseguiu eliminar por si própria, em vez de o contabilizar aqui. | | `already_deleted` | Sessões selecionadas que já tinham sido eliminadas, por exemplo por outro pedido, quando a tarefa as alcançou. |`deleted_child_verifications` conta as verificações que foram criadas por verificações de empresas eliminadas e que foram eliminadas com elas. Tem sempre o valor `0` numa tarefa iniciada por [Eliminar sessões em lote](https://docs.didit.me/pt/management-api/sessions/batch-delete.md), que elimina apenas sessões KYC.## PermissõesQualquer chave de API ativa da aplicação pode chamar este endpoint. Uma tarefa só é visível para a aplicação que a criou; qualquer outro `job_id` devolve `404`.## Relacionados- [Eliminar sessões em lote](https://docs.didit.me/pt/management-api/sessions/batch-delete.md) - [Eliminar sessão](https://docs.didit.me/pt/sessions-api/delete-session.md) - [Conservação de dados](https://docs.didit.me/pt/console/data-retention.md) ## OpenAPI ````yaml pt/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 tarefa de eliminação de sessões em massa description: >- Progresso de uma eliminação em massa de sessões à qual `POST /v3/sessions/delete/` respondeu com `202` (mais de 20 sessões correspondentes, selecionadas por `session_numbers` ou com `delete_all`). Efetue sondagens a cada poucos segundos enquanto `status` for `PENDING` ou `PROCESSING`; pare quando for `COMPLETED` ou `FAILED`. A tarefa comunica quantas sessões terminaram em cada resultado e quantas processou, nunca quais as sessões que eliminou. Uma tarefa em estado `FAILED` apresenta o motivo em `error`; as sessões a que ainda não tinha chegado permanecem intactas, pelo que deve repetir o pedido de eliminação para as eliminar. **Autenticação:** Chave de API no cabeçalho `x-api-key`. Uma tarefa só é visível para a aplicação que a criou; qualquer outro `job_id` devolve `404`. Credenciais em falta ou inválidas devolvem `403`; esta API nunca devolve `401`. operationId: get_session_deletion_job parameters: - name: job_id in: path required: true schema: type: string format: uuid description: O `job_id` devolvido 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 em falta. Uma chave em falta devolve `403`; uma chave incorreta, revogada ou expirada devolve `401`. content: application/json: schema: type: object properties: detail: type: string examples: Missing or invalid API key: summary: Sem cabeçalho x-api-key ou a chave é inválida value: detail: You do not have permission to perform this action. '404': description: >- Não existe nenhuma tarefa de eliminação com este `job_id` para a aplicação que faz o pedido. As tarefas só são visíveis para a aplicação que as 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: >- 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 eliminação em lote de sessões em execução em segundo plano: progresso e contagens por resultado, nunca quais sessões foram eliminadas. properties: job_id: type: string format: uuid description: Faça polling de `GET /v3/sessions/delete/{job_id}/` com este id. status: type: string enum: - PENDING - PROCESSING - COMPLETED - FAILED description: >- `PENDING`: aceite, ainda não iniciado. `PROCESSING`: a eliminar; `processed` e `outcomes` estão a ser atualizados. `COMPLETED`: todas as sessões selecionadas foram contabilizadas. `FAILED`: a tarefa parou prematuramente; consulte `error`. total: type: integer description: Sessões selecionadas quando a eliminação foi pedida. processed: type: integer description: Sessões que a tarefa concluiu até ao momento. 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 eliminadas juntamente com o seu embedding facial. none: type: integer description: Sessões eliminadas que não tinham embedding facial. retained_with_user: type: integer description: >- Sessões eliminadas enquanto um template biométrico sem imagem foi retido para o respetivo utilizador, a pedido ou de acordo com a política da aplicação. ineligible_no_vendor_user: type: integer description: >- Sessões eliminadas, com o seu embedding facial, porque a conservação de dados foi solicitada mas não tinham um utilizador associado. failed_retryable: type: integer description: >- Sessões reportadas como não eliminadas. Uma tarefa tenta novamente um grupo que não conseguiu eliminar por si própria em vez de o contabilizar aqui. already_deleted: type: integer description: >- Sessões selecionadas que já tinham sido eliminadas, por exemplo por outro pedido, quando a tarefa as alcançou. deleted_child_verifications: type: integer description: >- Verificações criadas pelas verificações de empresas eliminadas, eliminadas em conjunto com as mesmas. É sempre `0` para uma tarefa iniciada por `POST /v3/sessions/delete/`, que elimina 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 eliminação parou. As sessões que a tarefa ainda não tinha alcançado permanecem intactas: repita o pedido para as eliminar. created_at: type: string format: date-time description: Quando a eliminação foi pedida. completed_at: type: string format: date-time nullable: true description: Quando o trabalho terminou; `null` enquanto estiver em execução. securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- A chave de API da sua aplicação, a partir de Programadores -> Chaves de API na Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter o âmbito definido: nenhum, 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á incorreta, 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 o pedido veio de um endereço fora da sua lista de IP; 404 numa rota de sessão significa que a sessão está fora dos fluxos ou estados da chave. Uma chave sem acesso a multimédia recebe URLs de imagens, vídeos e PDFs como nulos, e uma chave sem permissão de escrita em sessões recebe ligações de sessão e tokens como nulos. Consulte https://docs.didit.me/console/api-keys. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.