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 suppression d'entreprises en lot : effacement KYB
Supprimez en masse des entités Business (KYB) de Didit par leur vendor_data ou didit_internal_id. Conforme au RGPD et au 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
}Vue d’ensemble
Supprime une ou plusieurs entreprises. Les enregistrements des entreprises sont supprimés définitivement. Les sessions de vérification d’entreprise (KYB) ne sont pas couvertes par cet endpoint : elles sont conservées, leur lien avec l’entreprise étant effacé. Supprimez-les avec Supprimer une session. Les transactions ne sont pas non plus couvertes : supprimez-les avec Suppression en lot des transactions.Quand l’utiliser
- Demandes de droit à l’effacement.
- Nettoyage des entreprises de test pendant la QA.
- Déprovisionnement des entreprises retirées de votre propre plateforme.
Remarques
- Accepte une liste de valeurs
vendor_dataou de valeursdidit_internal_id. - Idempotent : supprimer une entreprise déjà supprimée ne produit aucun effet.
- Renvoie uniquement le nombre d’éléments supprimés, et non un rapport par élément. Les valeurs qui ne correspondent à rien sont ignorées silencieusement.
- Émet
business.data.updatedavecdeleted_atrenseigné. - Les enregistrements appartenant à l’entreprise elle-même sont supprimés avec elle : ses liens de tags, son historique de commentaires, ainsi que ses propres enregistrements d’appareil et de réseau.
- Les enregistrements produits par une session KYB ne sont PAS supprimés : les données du registre des sociétés, les documents téléversés, les résultats AML, les bénéficiaires effectifs et les contrôles des personnes clés appartiennent à la session et subsistent jusqu’à ce que vous supprimiez la session elle-même.
Données dans un rapport réglementaire finalisé
Si l’une des entreprises sélectionnées fait partie d’un dossier comportant un rapport réglementaire finalisé, la requête entière renvoie409 et rien n’est supprimé. La réponse utilise code: in_filed_report et nomme chaque rapport :
{
"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"
}
]
}
Une suppression déjà en cours
Une entreprise est supprimée par une seule requête à la fois. Si une autre requête supprime encore l’une des entreprises sélectionnées, cette requête attend quelques secondes au maximum, puis renvoie409 avec code: subject_deletion_in_progress et ne supprime rien :
{
"detail": "This person or company is being deleted. Retry after deletion completes.",
"code": "subject_deletion_in_progress"
}
Autorisations
Le rôle doit accorderdelete:businesses. Cette autorisation est généralement réservée aux rôles OWNER et ADMIN.
Voir aussi
Autorisations
La clé API de votre application, issue de Développeurs -> Clés API dans la Business Console. La clé principale dispose d'un accès complet. Une clé nommée peut être restreinte : aucun, lecture ou écriture par ressource, limitée à certains workflows ou aux sessions approuvées, à une liste d'adresses IP et à une date d'expiration. 401 signifie que la clé est incorrecte, révoquée ou expirée ; 403 signifie qu'aucune clé n'a été envoyée, que la clé n'a pas accès à cette ressource ou action, ou que la requête provient d'une adresse hors de sa liste d'IP ; 404 sur une route de session signifie que la session est hors des workflows ou des statuts de la clé. Une clé sans accès aux médias reçoit les URL d'images, de vidéos et de PDF à null, et une clé sans accès en écriture aux sessions reçoit les liens et tokens de session à null. Voir https://docs.didit.me/console/api-keys.
Corps
Fournissez vendor_data_list, didit_internal_id_list ou delete_all: true. Ordre de priorité si plusieurs sont envoyés : delete_all > vendor_data_list > didit_internal_id_list (seul le sélecteur ayant la priorité la plus élevée est utilisé).
Vos propres identifiants à supprimer, mis en correspondance exacte avec ceux transmis.
UUID internes Didit (didit_internal_id) à supprimer.
Si true, supprime toutes les entreprises de l'application. Ne peut pas être combiné avec les sélecteurs de liste.
Réponse
Entreprises supprimées. Renvoie le nombre de lignes effectivement supprimées.
Nombre d'entreprises supprimées (exclut les valeurs de vendor_data qui ne correspondaient à rien).