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));{
"deleted": 2
}API de eliminação em lote de empresas: apagamento KYB
Elimine em massa entidades de empresas (KYB) da Didit por vendor_data ou didit_internal_id. Conforme com o RGPD e o 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));{
"deleted": 2
}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_dataou de valores dedidit_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.updatedcomdeleted_atdefinido. - 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 devolve409 e nada é eliminado. A resposta usa code: in_filed_report e indica 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"
}
]
}
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, devolve409 com code: subject_deletion_in_progress sem eliminar nada:
{
"detail": "This person or company is being deleted. Retry after deletion completes.",
"code": "subject_deletion_in_progress"
}
Permissões
A função tem de concederdelete:businesses. É normalmente reservada para OWNER e ADMIN.
Relacionados
Autorizações
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
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).
Os seus próprios identificadores a eliminar, correspondidos exatamente como foram enviados.
UUIDs internos da Didit (didit_internal_id) a eliminar.
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.
Número de empresas eliminadas (exclui valores de vendor_data que não corresponderam a nada).