Pular para o conteúdo principal
POST
curl

Visão geral

Exclui uma ou mais entidades de empresa. Os registros das empresas são removidos permanentemente. As sessões de Verificação de Empresa (KYB) não são abrangidas por este endpoint e continuam existindo, com o vínculo com a empresa removido; exclua-as com Excluir sessão. As transações também não são abrangidas; exclua-as com Excluir transações em lote.

Quando usar

  • Solicitações de direito de ser esquecido.
  • Limpeza de empresas de teste durante o QA.
  • Desprovisionamento de empresas removidas da sua própria plataforma.

Observações

  • Aceita uma lista de valores de vendor_data ou de didit_internal_id.
  • Idempotente: excluir uma empresa já excluída não tem nenhum efeito.
  • Retorna apenas a contagem do que foi excluído, e não um relatório por item. Valores que não correspondem a nada são ignorados sem aviso.
  • Emite business.data.updated com deleted_at preenchido.
  • Os registros que pertencem à própria entidade de empresa são excluídos com ela: seus vínculos de tags, seu histórico de comentários e seus próprios registros de dispositivo e de rede.
  • Os registros gerados por uma sessão de KYB NÃO são excluídos: dados do registro de empresas, documentos enviados, ocorrências de AML, beneficiários finais e verificações de pessoas-chave pertencem à sessão e continuam existindo até que você exclua a própria sessão.

Dados em um relatório regulatório finalizado

Se alguma das empresas selecionadas fizer parte de um caso com um relatório regulatório finalizado, a requisição inteira retorna 409 e nada é excluído. A resposta usa code: in_filed_report e identifica cada relatório:
Exclua cada relatório com Excluir relatório e, em seguida, repita a mesma requisição.

Permissões

A função precisa conceder delete:businesses. Essa permissão normalmente é reservada para OWNER e ADMIN.

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.

Corpo

application/json

Informe vendor_data_list, didit_internal_id_list ou delete_all: true. Precedência quando vários são enviados: delete_all > vendor_data_list > didit_internal_id_list (somente o seletor de maior precedência é usado).

vendor_data_list
string[]

Seus próprios identificadores a excluir, comparados exatamente como enviados.

didit_internal_id_list
string<uuid>[]

UUIDs internos da Didit (didit_internal_id) a excluir.

delete_all
boolean
padrão:false

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

Resposta

Empresas excluídas. Retorna o número de linhas efetivamente removidas.

deleted
integer

Número de empresas excluídas (não inclui valores de vendor_data que não corresponderam a nada).

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