curl -X POST https://verification.didit.me/v3/biometric-templates/delete/ \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"delete_all": true, "vendor_user_uuid": "2f7c1a9e-8b4d-4c6a-9e1f-3d5b7a9c1e2f"}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.biometric_templates.batch_delete(
template_uuids=["9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b", "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"],
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.biometricTemplates.batchDelete({
template_uuids: ["9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b", "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"],
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.BiometricTemplates.BatchDelete(ctx, didit.BiometricTemplatesBatchDeleteParams{
TemplateUUIDs: didit.Some([]string{"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b", "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"}),
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import java.util.List;
import me.didit.Didit;
import me.didit.types.BiometricTemplatesBatchDeleteParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.biometricTemplates().batchDelete(BiometricTemplatesBatchDeleteParams.builder()
.templateUuids(List.of("9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b", "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"))
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->biometricTemplates->batchDelete([
'template_uuids' => ['9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b', '1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d'],
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.biometric_templates.batch_delete(template_uuids: ["9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b", "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"])
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.BiometricTemplates.BatchDeleteAsync(new BiometricTemplatesBatchDeleteParams
{
TemplateUuids = new string[] { "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b", "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d" },
});
Console.WriteLine(JsonSerializer.Serialize(result));{
"results": [
{
"uuid": "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b",
"outcome": "purged"
},
{
"uuid": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
"outcome": "already_purged"
}
]
}生体認証テンプレート一括削除API
DiditのPOST /v3/biometric-templates/delete/で、保持中の顔の生体認証テンプレートをIDリスト指定、またはフィルターに一致する全件を一括削除できます。テンプレート単位で冪等です。
curl -X POST https://verification.didit.me/v3/biometric-templates/delete/ \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"delete_all": true, "vendor_user_uuid": "2f7c1a9e-8b4d-4c6a-9e1f-3d5b7a9c1e2f"}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.biometric_templates.batch_delete(
template_uuids=["9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b", "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"],
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.biometricTemplates.batchDelete({
template_uuids: ["9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b", "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"],
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.BiometricTemplates.BatchDelete(ctx, didit.BiometricTemplatesBatchDeleteParams{
TemplateUUIDs: didit.Some([]string{"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b", "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"}),
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import java.util.List;
import me.didit.Didit;
import me.didit.types.BiometricTemplatesBatchDeleteParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.biometricTemplates().batchDelete(BiometricTemplatesBatchDeleteParams.builder()
.templateUuids(List.of("9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b", "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"))
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->biometricTemplates->batchDelete([
'template_uuids' => ['9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b', '1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d'],
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.biometric_templates.batch_delete(template_uuids: ["9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b", "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"])
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.BiometricTemplates.BatchDeleteAsync(new BiometricTemplatesBatchDeleteParams
{
TemplateUuids = new string[] { "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b", "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d" },
});
Console.WriteLine(JsonSerializer.Serialize(result));{
"results": [
{
"uuid": "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b",
"outcome": "purged"
},
{
"uuid": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
"outcome": "already_purged"
}
]
}delete_all: trueのいずれかを指定します。必要に応じて、生体認証テンプレートの一覧取得と同じフィルターで対象を絞り込めます。
リクエストボディ
| フィールド | 型 | 説明 |
|---|---|---|
template_uuids | UUID[] | 削除するテンプレート。delete_allがtrueでない限り必須です。すでに削除済みのIDはalready_purgedとして報告されます。 |
delete_all | boolean | trueの場合、以下のフィルターに一致するすべてのテンプレートを削除します(フィルターを指定しない場合はアプリケーションのすべてのテンプレート)。template_uuidsは無視されます。 |
vendor_data | string | delete_all使用時のみ:所有するユーザーのvendor_dataに対する、大文字と小文字を区別しない部分一致 |
vendor_user_uuid | UUID | delete_all使用時のみ:所有するユーザーとの完全一致 |
status | enum | delete_all使用時のみ:pending、active、expired、held_out_of_use、purge_pending、purge_failed |
source_type | enum | delete_all使用時のみ:session_delete、automatic_retention、backfill |
retained_from, retained_to | datetime | delete_all使用時のみ:保持日の範囲 |
delete_all: trueを指定すると、アプリケーション内のすべての生体認証テンプレートが削除され、元に戻すことはできません。先に同じフィルターで生体認証テンプレートの件数取得を実行し、削除対象を確認してください。例
- IDで指定
- 1人のユーザーのすべてのテンプレート
- アプリケーション内のすべてのテンプレート
curl -X POST https://verification.didit.me/v3/biometric-templates/delete/ \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"template_uuids": ["9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b", "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"]}'
curl -X POST https://verification.didit.me/v3/biometric-templates/delete/ \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"delete_all": true, "vendor_user_uuid": "2f7c1a9e-8b4d-4c6a-9e1f-3d5b7a9c1e2f"}'
curl -X POST https://verification.didit.me/v3/biometric-templates/delete/ \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"delete_all": true}'
{
"results": [
{ "uuid": "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b", "outcome": "purged" },
{ "uuid": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d", "outcome": "already_purged" }
]
}
purgedまたはalready_purgedが返されます。生体認証ストアが利用できない場合、最初に失敗したテンプレートの時点でリクエストは503を返します。同じリクエスト内でそれより前に削除されたテンプレートは削除されたままとなり、失敗したテンプレートはpurge_failedに移行します(照合の対象からはすでに除外されています)。リクエストを再度実行すると処理が完了します。
エラー
| ステータス | 発生条件 | ボディ |
|---|---|---|
400 | template_uuidsとdelete_all: trueのどちらも指定されていない | {"template_uuids": ["This field is required unless delete_all is true."]} |
400 | フィルターの値が無効、またはretained_toがretained_fromより前 | フィールドごとのバリデーションエラー |
403 | コンソールユーザートークンが使用されている、またはAPIキーが許可されていない | {"detail": "You do not have permission to perform this action."} |
503 | 生体認証ストアが利用できなかった。リクエストを再試行してください | {"detail": "The biometric-template operation could not finish because an external store is unavailable. The operation is retryable."} |
承認
お客様のアプリケーションのAPIキーです。Business ConsoleのDevelopers -> API keysで取得できます。プライマリキーはフルアクセス権を持ちます。名前付きキーにはスコープを設定できます。リソースごとのアクセス権(なし、読み取り、書き込み)、一部のワークフローまたは承認済みセッションへの限定、IPアドレスのリストへの限定、有効期限の設定です。401は、キーが誤っている、失効している、または期限切れであることを意味します。403は、キーが送信されていない、キーにこのリソースやアクションへのアクセス権がない、またはIPリスト外のアドレスからリクエストが送信されたことを意味します。セッションのルートでの404は、セッションがキーのワークフローまたはステータスの対象外であることを意味します。メディアへのアクセス権がないキーでは、画像、動画、PDFのURLがnullで返されます。セッションの書き込み権限がないキーでは、セッションのリンクとトークンがnullで返されます。詳細は次を参照してください: https://docs.didit.me/console/api-keys
ボディ
完全に削除するテンプレート。delete_allがtrueでない限り必須です。すでに削除済みのIDはalready_purgedとして報告されます。
1trueの場合、以下のフィルターに一致するすべてのテンプレートを完全に削除します(フィルターを指定しない場合は、アプリケーションのすべてのテンプレートが対象です)。template_uuidsは無視されます。元に戻すことはできません。
delete_allの場合のみ: 所有ユーザーのvendor_dataに対する、大文字と小文字を区別しない部分文字列一致です。
delete_allを指定した場合のみ: 所有者であるユーザーとの完全一致。
delete_allの場合のみ。
pending, active, expired, held_out_of_use, purge_pending, purge_failed delete_allの場合のみ。
session_delete, automatic_retention, backfill delete_allの場合のみ。
delete_allの場合のみ。retained_fromより前の値は指定できません。
レスポンス
テンプレートごとのパージ結果です。
Show child attributes
Show child attributes