Saltar para o conteúdo principal
POST
curl
Purga muitos modelos numa única chamada. Indique uma lista explícita de ids ou delete_all: true, opcionalmente restringida pelos mesmos filtros de Listar templates biométricos.

Corpo do pedido

delete_all: true sem filtros purga todos os templates biométricos da aplicação e não pode ser revertido. Execute primeiro Contar templates biométricos com os mesmos filtros para confirmar o que será purgado.

Exemplos

Os modelos são purgados um a um; cada resultado indica purged ou already_purged. Se um armazenamento biométrico estiver indisponível, a chamada devolve 503 no primeiro modelo que falhar. Os modelos purgados antes no mesmo pedido mantêm-se purgados, o modelo que falhou passa para purge_failed (já excluído da correspondência), e repetir o pedido conclui a purga.

Erros

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
template_uuids
string<uuid>[]

Modelos a eliminar definitivamente. Obrigatório, exceto se delete_all for true. Os IDs já eliminados são reportados como already_purged.

Minimum array length: 1
delete_all
boolean
padrão:false

Quando true, purga todos os modelos correspondentes aos filtros abaixo (todos os modelos da aplicação quando nenhum filtro é fornecido). template_uuids é ignorado. Irreversível.

vendor_data
string

Apenas com delete_all: correspondência de substring sem distinção entre maiúsculas e minúsculas no vendor_data do utilizador proprietário.

vendor_user_uuid
string<uuid>

Apenas com delete_all: correspondência exata no utilizador proprietário.

status
enum<string>

Apenas com delete_all.

Opções disponíveis:
pending,
active,
expired,
held_out_of_use,
purge_pending,
purge_failed
source_type
enum<string>

Apenas com delete_all.

Opções disponíveis:
session_delete,
automatic_retention,
backfill
retained_from
string<date-time>

Apenas com delete_all.

retained_to
string<date-time>

Apenas com delete_all. Não pode ser anterior a retained_from.

Resposta

Resultados de eliminação por modelo.

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