メインコンテンツへスキップ
GET
curl
テンプレートを1件返します。Delete Sessionが返すbiometric_template_uuid、顔検索の一致結果のbiometric_template_id、または一覧から取得したIDを使用してください。
レスポンスには、画像、ベクトル、削除されたセッションのID、本人を特定するデータは一切含まれません。すべてのフィールドについては概要を参照してください。

エラー

承認

x-api-key
string
header
必須

お客様のアプリケーションのAPIキーです。Business ConsoleのDevelopers -> API keysで取得できます。プライマリキーはフルアクセス権を持ちます。名前付きキーにはスコープを設定できます。リソースごとのアクセス権(なし、読み取り、書き込み)、一部のワークフローまたは承認済みセッションへの限定、IPアドレスのリストへの限定、有効期限の設定です。401は、キーが誤っている、失効している、または期限切れであることを意味します。403は、キーが送信されていない、キーにこのリソースやアクションへのアクセス権がない、またはIPリスト外のアドレスからリクエストが送信されたことを意味します。セッションのルートでの404は、セッションがキーのワークフローまたはステータスの対象外であることを意味します。メディアへのアクセス権がないキーでは、画像、動画、PDFのURLがnullで返されます。セッションの書き込み権限がないキーでは、セッションのリンクとトークンがnullで返されます。詳細は次を参照してください: https://docs.didit.me/console/api-keys

パスパラメータ

template_uuid
string<uuid>
必須

テンプレートID。セッション削除エンドポイントが返すbiometric_template_uuid、顔検索の一致結果のbiometric_template_id、または一覧エンドポイントで返される値です。

例:

"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b"

レスポンス

テンプレート。

uuid
string<uuid>

テンプレートID。ランダムに生成され、削除されたセッションやその顔から導出されたものではありません。

vendor_user_uuid
string<uuid>

所有者のUser。

vendor_data
string | null

ユーザーの現在のvendor_dataで、テンプレートを読み取る時点で解決されます(コピーされることはありません)。

source_type
enum<string>

テンプレートの作成方法。セッションの削除(APIまたはConsole)、アプリケーションの自動データ保持期間、またはお客様の指示によりDiditが実施したバックフィルのいずれかです。

利用可能なオプション:
session_delete,
automatic_retention,
backfill
provenance_reference
string<uuid>

テンプレートをその監査証跡に紐付ける不透明な参照です。削除されたセッションのidではなく、そのidに解決することもできません。

retention_policy
enum<string>

保持時点でのアプリケーションのポリシー。

利用可能なオプション:
delete_with_session,
retain_until_user_deleted
retention_override
boolean | null

削除時に送信されたretain_face_embeddingsの値です。ポリシーが適用された場合はnullです。

retained_at
string<date-time>
expires_at
string<date-time>

テンプレートの有効期限が切れ、自動的に削除される日時。常に設定されます。

retained_by
string | null

指示を出した主体。APIキーの場合はアプリケーションID、Consoleでのアクションの場合はConsoleメンバーID、自動保持の場合はservice:識別子です。メールアドレスになることはありません。

retained_by_type
enum<string>
利用可能なオプション:
API_KEY,
CONSOLE_USER,
SYSTEM
instruction_class
enum<string>
利用可能なオプション:
operational_session_delete,
privacy_erasure
instruction_source
enum<string>
利用可能なオプション:
api,
console,
automatic_retention,
backfill,
privacy_erasure,
explicit_template_purge,
vendor_user_delete,
expiry,
reconciliation,
migration,
system
instruction_id
string

削除時に送信されたinstruction_id、またはDiditが生成したIDです。

held_out_of_use
boolean

法的保全が適用されている間のみtrueです。保全中のテンプレートはすべての照合から除外されます。

status
enum<string>

マッチングの対象になるのは、保留されておらず、expires_atを過ぎておらず、ユーザーがまだ存在するactiveテンプレートのみです。

利用可能なオプション:
pending,
active,
expired,
held_out_of_use,
purge_pending,
purge_failed,
purged
purged_at
string<date-time> | null
最終更新日 2026年11月1日