curl -X POST 'https://verification.didit.me/v3/businesses/delete/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"vendor_data_list": ["company-123", "company-456"]}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.businesses.batch_delete(
vendor_data_list=["company-123", "company-456"],
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.businesses.batchDelete({
vendor_data_list: ["company-123", "company-456"],
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Businesses.BatchDelete(ctx, didit.BusinessesBatchDeleteParams{
VendorDataList: didit.Some([]string{"company-123", "company-456"}),
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import java.util.List;
import me.didit.Didit;
import me.didit.types.BusinessesBatchDeleteParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.businesses().batchDelete(BusinessesBatchDeleteParams.builder()
.vendorDataList(List.of("company-123", "company-456"))
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->businesses->batchDelete([
'vendor_data_list' => ['company-123', 'company-456'],
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.businesses.batch_delete(vendor_data_list: ["company-123", "company-456"])
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Businesses.BatchDeleteAsync(new BusinessesBatchDeleteParams
{
VendorDataList = new string[] { "company-123", "company-456" },
});
Console.WriteLine(JsonSerializer.Serialize(result));API para excluir empresas em lote: remoção de dados KYB
Exclua em lote entidades de empresas (KYB) na Didit por vendor_data ou didit_internal_id, em conformidade com GDPR/CCPA.
curl -X POST 'https://verification.didit.me/v3/businesses/delete/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"vendor_data_list": ["company-123", "company-456"]}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.businesses.batch_delete(
vendor_data_list=["company-123", "company-456"],
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.businesses.batchDelete({
vendor_data_list: ["company-123", "company-456"],
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Businesses.BatchDelete(ctx, didit.BusinessesBatchDeleteParams{
VendorDataList: didit.Some([]string{"company-123", "company-456"}),
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import java.util.List;
import me.didit.Didit;
import me.didit.types.BusinessesBatchDeleteParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.businesses().batchDelete(BusinessesBatchDeleteParams.builder()
.vendorDataList(List.of("company-123", "company-456"))
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->businesses->batchDelete([
'vendor_data_list' => ['company-123', 'company-456'],
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.businesses.batch_delete(vendor_data_list: ["company-123", "company-456"])
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Businesses.BatchDeleteAsync(new BusinessesBatchDeleteParams
{
VendorDataList = new string[] { "company-123", "company-456" },
});
Console.WriteLine(JsonSerializer.Serialize(result));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_dataou dedidit_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.updatedcomdeleted_atpreenchido. - 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 retorna409 e nada é excluído. A resposta usa code: in_filed_report e identifica cada relatório:
{
"detail": "A case about this person or company has a filed regulatory report, so it cannot be deleted.",
"code": "in_filed_report",
"reports": [
{
"uuid": "5ec00000-0000-4000-8000-000000000007",
"report_number": "SAR-0001",
"report_type": "SAR",
"case_uuid": "c1a5e000-0000-4000-8000-000000000001"
}
]
}
Permissões
A função precisa concederdelete:businesses. Essa permissão normalmente é reservada para OWNER e ADMIN.
Relacionados
Autorizações
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
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).
Seus próprios identificadores a excluir, comparados exatamente como enviados.
UUIDs internos da Didit (didit_internal_id) a excluir.
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.
Número de empresas excluídas (não inclui valores de vendor_data que não corresponderam a nada).