Saltar para o conteúdo principal
POST
curl

​
Comportamento

Cada sessão correspondente é eliminada exatamente como em Eliminar sessão: a sessão, todas as tentativas de verificação que contém, a respetiva decisão e dados extraídos, os seus registos de funcionalidades e todos os ficheiros armazenados são eliminados, deixa de aparecer em todos os endpoints de leitura, e os URLs de média emitidos anteriormente deixam de ser resolvidos. As entregas de webhook ainda em fila para uma sessão eliminada, bem como as respetivas novas tentativas, são descartadas; os webhooks já entregues não são afetados. A eliminação é permanente e irreversível. Se alguma sessão selecionada fizer parte de um relatório regulamentar finalizado, o pedido inteiro devolve 409 e nada é eliminado. A resposta usa code: in_filed_report e indica cada relatório. Elimine cada relatório com Eliminar relatório e, em seguida, repita o pedido. Eliminar o relatório não elimina a sessão; a sessão permanece até repetir este pedido. O número de sessões correspondentes determina a forma como o pedido é respondido, quer as selecione com session_numbers, quer com delete_all: Um resultado confirma que a sessão foi eliminada, exceto quando o respetivo face_retention_outcome é failed_retryable: essa sessão não foi eliminada e permanece, pelo que deve tratar esse resultado como uma falha a repetir, nunca como confirmação de eliminação. Os números que não correspondem a uma sessão KYC ativa na sua aplicação são ignorados e não aparecem em results.

​
Restringir delete_all com filtros

Com delete_all: true pode restringir a seleção com os filtros de Listar sessões, cada um precedido de filter_. Aceitam os mesmos valores que os parâmetros de consulta. Um filtro que aceita vários valores (status, workflow_id, country, region, document_type, document_name, session_type, warning, organization_name) aceita uma cadeia separada por vírgulas ou um array:
  • Os filtros só se aplicam em conjunto com delete_all; com session_numbers são validados, mas não alteram a seleção.
  • Todos os outros filtros aceitam um único valor. Um array é unido num único valor separado por vírgulas, pelo que várias datas, UUIDs ou valores de api_service devolvem 400, e vários textos de vendor_data, search ou screened_full_name não são comparados como alternativas.
  • Um filtro com valor vazio é ignorado e, por isso, não restringe a seleção.
  • Uma chave filter_* desconhecida devolve 400 {"filter_reviewer": "Unknown filter."}, e um valor que não pode ser lido devolve 400 associado a essa chave filter_*, como {"filter_date_from": ["Enter a valid date."]}. Nada é eliminado em nenhum dos casos, pelo que um filtro com erro de escrita nunca alarga a eliminação a todas as sessões.
  • Uma tarefa de eliminação aplica os mesmos filtros e, tal como qualquer delete_all, abrange apenas as sessões criadas antes do pedido.

​
Campos de retenção e de instrução

O endpoint aceita os mesmos campos opcionais do endpoint de sessão individual e aplica-os a todas as sessões correspondentes: Consulte Eliminar sessão para saber o que um modelo retido contém e o que não contém, como é calculado expires_at e o que faz uma instrução de eliminação por privacidade.

​
Resultados por sessão

Para até 20 sessões correspondentes, 200 OK devolve um resultado por sessão:
Cada resultado inclui os mesmos campos da resposta de Eliminar sessão. biometric_template_expires_at indica quando um modelo retido é eliminado, e deleted_child_verifications é sempre 0 neste caso, porque este endpoint elimina apenas sessões KYC. As sessões são eliminadas em grupos. Quando um grupo não pode ser eliminado, cada sessão desse grupo é indicada como failed_retryable; os outros grupos não são afetados e continuam eliminados.

​
Seleções grandes executadas como tarefa

Quando mais de 20 sessões correspondem, a resposta é 202 Accepted com uma tarefa de eliminação em vez de results:
Consulte Obter tarefa de eliminação de sessão a cada poucos segundos até status ser COMPLETED ou FAILED.
  • A tarefa indica quantas sessões resultaram em cada desfecho, mas nunca indica quais sessões eliminou.
  • Uma tarefa delete_all elimina apenas as sessões criadas antes do seu pedido. As sessões iniciadas enquanto a tarefa está em execução não são eliminadas.
  • Os campos de retenção e de instrução do seu pedido aplicam-se a todas as sessões que a tarefa eliminar.
  • Se um grupo ainda não puder ser eliminado, a tarefa volta a tentá-lo automaticamente.
  • Uma tarefa FAILED explica o motivo em error. As sessões que ela não chegou a processar continuam intactas: repita o pedido para as eliminar.

​
Exemplos

​
Migração a partir de respostas 204

Até esta versão, o endpoint devolvia 204 No Content. Agora devolve 200 OK com results[], ou 202 Accepted com uma tarefa de eliminação quando há mais de 20 sessões correspondentes. Atualize os clientes que validam 204. O comportamento de eliminação por defeito não mudou: as aplicações existentes continuam com delete_with_session até que altere a política explicitamente.

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

Corpo

application/json
​
session_numbers
string[]

Valores numéricos de session_number das sessões de KYC a eliminar, como strings compostas apenas por dígitos (números JSON também são aceites e convertidos). Obrigatório, salvo se delete_all for true; uma lista vazia devolve 400. Qualquer entrada com carateres não numéricos rejeita todo o pedido com 400 (exceto se delete_all for true, caso em que a validação é ignorada e as entradas não são consideradas). Números que não correspondam a uma sessão ativa na sua aplicação são ignorados silenciosamente.

Minimum array length: 1
Pattern: ^[0-9]+$
Exemplo:
​
delete_all
boolean
padrão:false

Quando true, todas as sessões de KYC restantes na aplicação que efetua a chamada são eliminadas e session_numbers é ignorado, a menos que restrinja a seleção com chaves filter_*. Mais de 20 sessões correspondentes são processadas como uma tarefa de eliminação (202) que abrange apenas as sessões criadas antes do pedido. O valor predefinido é false. Irreversível; não existe um passo de confirmação.

Exemplo:

false

​
retain_face_embeddings
boolean | null

Substitui a face_retention_policy da aplicação para esta eliminação. true mantém um template biométrico facial sem imagem associado ao utilizador da sessão após a sessão ser eliminada; false elimina o embedding facial com a sessão; omita ou use null para seguir a política da aplicação. Ignorado para sessões KYB e para sessões sem embedding facial.

Exemplo:

true

​
face_retention_days
integer

Duração finita de conservação, em dias, para um modelo conservado. Obrigatória quando um modelo é conservado, a menos que a aplicação já defina face_retention_days. O expires_at do modelo é determinado pelo limite mais cedo entre esta duração, a janela geral de conservação de dados da aplicação e face_retention_deadline.

Intervalo necessário: 1 <= x <= 3650
Exemplo:

365

​
face_retention_deadline
string<date-time>

Data de expiração definitiva opcional para um modelo retido. Tem de ser no futuro.

Exemplo:

"2027-08-28T00:00:00Z"

​
deletion_instruction
enum<string>
padrão:operational_session_delete

A classe de instrução que está a fornecer. operational_session_delete elimina a sessão e retém um modelo apenas quando a política ou retain_face_embeddings o determinar. privacy_erasure elimina permanentemente todos os templates biométricos retidos associados ao utilizador da sessão antes de eliminar a sessão, não pode ser substituído pela política da aplicação e não pode ser combinado com retain_face_embeddings: true (400).

Opções disponíveis:
operational_session_delete,
privacy_erasure
Exemplo:

"operational_session_delete"

​
instruction_id
string

A sua referência duradoura para esta instrução de eliminação (por exemplo, o id de um pedido de eliminação). Registada no registo de auditoria e em qualquer modelo retido. Gerada pela Didit quando omitida.

Maximum string length: 255
Exemplo:

"dsar-2026-0142"

​
filter_status

Restringe um delete_all às sessões que correspondam ao filtro status de List Sessions, com os mesmos valores. Uma string separada por vírgulas ou um array. Ignorado sem delete_all. Um valor vazio é ignorado e não restringe a seleção.

​
filter_vendor_data
string

Restringe um delete_all às sessões que correspondam ao filtro vendor_data de List Sessions, com o mesmo valor. Um único valor, não uma lista: um array é unido num único texto separado por vírgulas, pelo que múltiplos valores não são correspondidos como alternativas. Ignorado sem delete_all. Um valor vazio é ignorado e não restringe a seleção.

​
filter_search
string

Restringe um delete_all às sessões que correspondam ao filtro search de List Sessions, com o mesmo valor. Um único valor, não uma lista: um array é unido num único texto separado por vírgulas, pelo que múltiplos valores não são correspondidos como alternativas. Ignorado sem delete_all. Um valor vazio é ignorado e não restringe a seleção.

​
filter_workflow_id

Restringe um delete_all às sessões que correspondam ao filtro workflow_id de List Sessions, com os mesmos valores. Uma string separada por vírgulas ou um array. Ignorado sem delete_all. Um valor vazio é ignorado e não restringe a seleção.

​
filter_date_from
string<date>

Restringe um delete_all às sessões que correspondam ao filtro date_from de List Sessions, com o mesmo valor. Um valor, não uma lista: um array é unido num único valor separado por vírgulas, pelo que vários valores são recusados com 400. Ignorado sem delete_all. Um valor vazio é ignorado e não restringe a seleção.

​
filter_date_to
string<date>

Restringe um delete_all às sessões que correspondam ao filtro date_to de List Sessions, com o mesmo valor. Um valor, não uma lista: um array é unido num único valor separado por vírgulas, pelo que vários valores são recusados com 400. Ignorado sem delete_all. Um valor vazio é ignorado e não restringe a seleção.

​
filter_country

Restringe um delete_all às sessões que correspondam ao filtro country de List Sessions, com os mesmos valores. Uma cadeia de carateres separada por vírgulas ou um array. Ignorado sem delete_all. Um valor vazio é ignorado e não restringe a seleção.

​
filter_document_type

Restringe um delete_all às sessões que correspondam ao filtro document_type de List Sessions, com os mesmos valores. Uma cadeia de carateres separada por vírgulas ou um array. Ignorado sem delete_all. Um valor vazio é ignorado e não restringe a seleção.

​
filter_document_name

Restringe um delete_all às sessões que correspondam ao filtro document_name de List Sessions, com os mesmos valores. Uma cadeia de carateres separada por vírgulas ou um array. Ignorado sem delete_all. Um valor vazio é ignorado e não restringe a seleção.

​
filter_region

Restringe um delete_all às sessões que correspondam ao filtro region de List Sessions, com os mesmos valores. Uma string separada por vírgulas ou um array. Ignorado sem delete_all. Um valor vazio é ignorado e não restringe a seleção.

​
filter_didit_internal_id
string<uuid>

Restringe um delete_all às sessões que correspondam ao filtro didit_internal_id de List Sessions, com o mesmo valor. Um valor, não uma lista: um array é unido num único valor separado por vírgulas, pelo que vários valores são recusados com 400. Ignorado sem delete_all. Um valor vazio é ignorado e não restringe a seleção.

​
filter_session_type

Restringe um delete_all às sessões que correspondam ao filtro session_type de List Sessions, com os mesmos valores. Uma string separada por vírgulas ou um array. Ignorado sem delete_all. Um valor vazio é ignorado e não restringe a seleção.

​
filter_api_service
string

Restringe um delete_all às sessões que correspondam ao filtro api_service de List Sessions, com o mesmo valor. Um valor, não uma lista: um array é unido num único valor separado por vírgulas, pelo que vários valores são recusados com 400. Ignorado sem delete_all. Um valor vazio é ignorado e não restringe a seleção.

​
filter_screened_full_name
string

Restringe um delete_all às sessões que correspondam ao filtro screened_full_name de List Sessions, com o mesmo valor. Um único valor, não uma lista: um array é unido num único texto separado por vírgulas, pelo que múltiplos valores não são correspondidos como alternativas. Ignorado sem delete_all. Um valor vazio é ignorado e não restringe a seleção.

​
filter_warning

Restringe um delete_all às sessões que correspondam ao filtro warning de List Sessions, com os mesmos valores. Uma string separada por vírgulas ou um array. Ignorado sem delete_all. Um valor vazio é ignorado e não restringe a seleção.

​
filter_status_initialized_as_in_review
boolean

Restringe um delete_all às sessões que correspondam ao filtro status_initialized_as_in_review de List Sessions, com os mesmos valores. Ignorado sem delete_all. Um valor vazio é ignorado e não restringe a seleção.

​
filter_is_kyc_to_be_reviewed
boolean

Restringe um delete_all às sessões que correspondam ao filtro is_kyc_to_be_reviewed de List Sessions, com os mesmos valores. Ignorado sem delete_all. Um valor vazio é ignorado e não restringe a seleção.

​
filter_euuid
string<uuid>

Restringe um delete_all às sessões que correspondam ao filtro euuid de List Sessions, com o mesmo valor. Um valor, não uma lista: um array é unido num único valor separado por vírgulas, pelo que vários valores são recusados com 400. Ignorado sem delete_all. Um valor vazio é ignorado e não restringe a seleção.

​
filter_organization_name

Restringe um delete_all às sessões que correspondam ao filtro organization_name de List Sessions, com os mesmos valores. Uma string separada por vírgulas ou um array. Com uma chave de API, só pode corresponder ao nome da sua própria organização, pelo que seleciona todas as suas sessões ou nenhuma. Ignorado sem delete_all. Um valor vazio é ignorado e não restringe a seleção.

Resposta

Até 20 sessões corresponderam e foram processadas no pedido. Um resultado por sessão correspondente; números que não corresponderam a nada (desconhecidos ou já eliminados) são ignorados e não aparecem. Um resultado confirma a eliminação, exceto quando face_retention_outcome for failed_retryable: essa sessão NÃO foi eliminada e deve ser tentada novamente.

​
results
object[]
Última modificação em 7 de novembro de 2026