メインコンテンツへスキップ
GET
curl
1つのリストのエントリーを新しい順に取得します。任意で検索もできます。searchは、エントリーの値またはラベルの一部に大文字・小文字を区別せずに一致します。reference_session_idを指定すると、1つの認証セッションから取り込まれたエントリーに結果を絞り込めます。顔リストでは、metadata.face_image_sourceにより、各エントリーがセッション内のどの顔に対応するかがわかります(存在しない場合はliveness)。 顔と書類のエントリーは、metadataに画像URLを含みます。これらのURLは呼び出しから間もなく期限切れになります。URLを保存せず、新しいURLが必要なときはエントリーを再度取得してください。media: readを持たないAPIキーでは、これらのURLはnullとして返されます。

承認

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で返される値を指定します。

クエリパラメータ

エントリーのvalueまたはdisplay_labelに含まれている必要がある、大文字・小文字を区別しないテキスト。

reference_session_id
string<uuid>

この本人認証セッションから取得されたエントリのみ。例えば、そのセッションの顔のうちどれがすでに登録されているかを確認する場合に使用します。

limit
integer
デフォルト:50

ページサイズ。デフォルトは50です。1000000を超える値は400を返します。0、負の値、数値以外の値の場合は50が使用されます。

必須範囲: 1 <= x <= 1000000
offset
integer
デフォルト:0

返す最初の項目の0始まりのインデックスです。nextをたどる方法を推奨します。1000000を超える値は400を返し、負の値または数値以外の値は0として扱われます。

必須範囲: 0 <= x <= 1000000

レスポンス

エントリーのページ(新しい順)。

count
integer
必須

フィルターに一致するエントリーの総数。

必須範囲: x >= 0
next
string<uri> | null
必須

次のページの絶対URL。最後のページではnullになります。

previous
string<uri> | null
必須

前のページの絶対URL。最初のページではnullになります。

results
object[]
必須
最終更新日 2026年11月1日