Saltar para o conteúdo principal
GET
curl

Visão geral

Devolve uma eliminação de sessões em massa iniciada por Eliminar sessões em lote: 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: 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

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

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, que elimina apenas sessões KYC.

Permissões

Qualquer 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

Autorizações

x-api-key
string
header
obrigatório

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.

Parâmetros de caminho

job_id
string<uuid>
obrigatório

O job_id devolvido com o 202 de POST /v3/sessions/delete/.

Resposta

A tarefa.

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.

job_id
string<uuid>

Faça polling de GET /v3/sessions/delete/{job_id}/ com este id.

status
enum<string>

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.

Opções disponíveis:
PENDING,
PROCESSING,
COMPLETED,
FAILED
total
integer

Sessões selecionadas quando a eliminação foi pedida.

processed
integer

Sessões que a tarefa concluiu até ao momento.

outcomes
object

Quantas sessões terminaram em cada resultado. Todas as chaves estão sempre presentes.

deleted_child_verifications
integer

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
string | null

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
string<date-time>

Quando a eliminação foi pedida.

completed_at
string<date-time> | null

Quando o trabalho terminou; null enquanto estiver em execução.

Última modificação em 7 de novembro de 2026