Pular para o conteúdo principal
GET
curl

Visão geral

Retorna uma exclusão em massa de sessões iniciada por Excluir sessões em lote: 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: 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

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

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

Permissões

Qualquer 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

Autorizações

x-api-key
string
header
obrigatório

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.

Parâmetros de caminho

job_id
string<uuid>
obrigatório

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

Resposta

A tarefa.

Uma exclusão de sessões em massa executada em segundo plano: progresso e contagens por resultado, nunca quais sessões ela excluiu.

job_id
string<uuid>

Consulte GET /v3/sessions/delete/{job_id}/ periodicamente com este id.

status
enum<string>

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.

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

Sessões selecionadas quando a exclusão foi solicitada.

processed
integer

Sessões que o job já concluiu até agora.

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

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

Quando a exclusão foi solicitada.

completed_at
string<date-time> | null

Quando o job terminou; null enquanto está em execução.

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