Saltar para o conteúdo principal
POST
curl

Visão geral

Elimina uma ou mais entidades empresariais. Os registos das empresas são removidos de forma permanente. As sessões de Verificação de empresas (KYB) não são abrangidas por este endpoint e mantêm-se, com a ligação à empresa removida; elimine-as com Eliminar sessão. As transações também não são abrangidas; elimine-as com Eliminar transações em lote.

Quando usar

  • Pedidos de direito ao esquecimento.
  • Limpeza de empresas de teste durante o QA.
  • Desprovisionamento de empresas removidas da sua própria plataforma.

Notas

  • Aceita uma lista de valores de vendor_data ou de valores de didit_internal_id.
  • Idempotente: eliminar uma empresa já eliminada não tem efeito.
  • Devolve apenas uma contagem do que foi eliminado, e não um relatório por item. Os valores que não correspondem a nada são ignorados sem aviso.
  • Emite business.data.updated com deleted_at definido.
  • Os registos pertencentes à própria entidade empresarial são eliminados com ela: as suas ligações de etiquetas, o histórico de comentários e os seus próprios registos de dispositivo e de rede.
  • Os registos produzidos por uma sessão KYB NÃO são eliminados: os dados do registo de empresas, os documentos carregados, os resultados AML, os beneficiários efetivos e as verificações de pessoas-chave pertencem à sessão e mantêm-se até eliminar a própria sessão.

Dados num relatório regulamentar finalizado

Se alguma das empresas selecionadas fizer parte de um caso com um relatório regulamentar finalizado, todo o pedido 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 mesmo pedido.

Uma eliminação já em curso

Uma empresa só pode ser eliminada por um pedido de cada vez. Se outro pedido ainda estiver a eliminar uma das empresas selecionadas, este pedido aguarda, no máximo, alguns segundos e, depois, devolve 409 com code: subject_deletion_in_progress sem eliminar nada:
Repita o mesmo pedido quando a outra eliminação terminar. Uma empresa que essa eliminação já tenha removido deixa de corresponder, pelo que a repetição elimina apenas o que restar.

Permissões

A função tem de conceder delete:businesses. É normalmente reservada para OWNER e ADMIN.

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

Forneça vendor_data_list, didit_internal_id_list ou delete_all: true. Ordem de precedência quando vários são enviados: delete_all > vendor_data_list > didit_internal_id_list (apenas o seletor com maior precedência é utilizado).

vendor_data_list
string[]

Os seus próprios identificadores a eliminar, correspondidos exatamente como foram enviados.

didit_internal_id_list
string<uuid>[]

UUIDs internos da Didit (didit_internal_id) a eliminar.

delete_all
boolean
padrão:false

Se true, elimina todas as empresas na aplicação. Não pode ser combinado com os seletores de lista.

Resposta

Empresas eliminadas. Devolve o número de linhas efetivamente removidas.

deleted
integer

Número de empresas eliminadas (exclui valores de vendor_data que não corresponderam a nada).

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