メインコンテンツへスキップ
GET
curl
1件のリストの詳細を取得します。エントリー数と、最新のエントリーが追加された日時も含まれます。別のアプリケーションのリスト、または削除されたリストを指定すると404が返されます。 リスト内の値を読み取るには、エントリー一覧を使用してください。

承認

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

パスパラメータ

list_uuid
string<uuid>
必須

リストのUUIDです。List listsまたはCreate a listで返される値を指定します。

レスポンス

リストです。

1つのアプリケーションのブロックリスト、許可リスト、またはカスタムリスト。

uuid
string<uuid>
必須

リストの識別子です。リストおよびエントリのエンドポイントではlist_uuidとして使用し、value_type: "list"のワークフローまたは取引ルールの条件では値として使用します。

name
string
必須

リスト名です。アプリケーションのリスト内で一意です。

Maximum string length: 255
description
string
必須

自由記述の説明。未設定の場合は空文字列です。

list_type
enum<string>
必須

blocklist:一致するとセッションまたは取引が却下されます(システムリストのみ、エントリタイプごとに1つ)。allowlist:一致した項目は信頼されます。たとえば顔の許可リストでは重複顔のアクションがスキップされます。ブロックリストの一致を上書きすることはありません。custom:ワークフローおよび取引ルールの条件で使用されます(value_type: "list")。

利用可能なオプション:
blocklist,
allowlist,
custom
entry_type
enum<string>
必須

リストが保持する内容です。face、document(書類番号)、phone、email、ip_address(IPアドレスまたはCIDR範囲)、device_fingerprint、wallet_address、bank_account、country(ISO 3166-1 alpha-3)、userまたはbusiness(お客様のvendor_data)、key(任意の文字列)のいずれかです。エントリの値の検証方法と照合方法はこれによって決まります。

利用可能なオプション:
face,
document,
phone,
email,
ip_address,
device_fingerprint,
wallet_address,
bank_account,
country,
user,
business,
key
is_system
boolean
必須

Diditが用意するリストではtrueです。対象は、エントリタイプごとに1つずつ用意されるブロックリスト(face、document、phone、email、ip_address、device_fingerprint、wallet_address、bank_account、user、business)、High Risk Countriesカスタムリスト、およびシステム許可リストです。システムリストは名前の変更、編集、削除ができません。エントリの追加と削除は可能です。

entry_count
integer
必須

現在リストに含まれるエントリー数。

必須範囲: x >= 0
last_entry_added_at
string<date-time> | null
必須

最新の現行エントリが追加された日時。空のリストではnullです。

created_at
string<date-time>
必須

リストが作成された日時。

updated_at
string<date-time>
必須

リストが最後に更新された日時。

最終更新日 2026年11月1日