メインコンテンツへスキップ
POST
Python
DiditのLook Up Users APIは、最大20,000件の識別子を1回の呼び出しでアプリケーションのユーザーに対応付け、一致するユーザーがいなかった識別子を示します。 アカウントのリストがあり、各アカウントの認証ステータスが必要な場合に使用します。たとえば、支払いバッチの受取人、パートナーのアカウント、不正検知クエリの出力などが該当します。

仕組み

  1. 照合を実行。 POST /v3/users/lookup/ に識別子を指定して呼び出します。この呼び出しは読み取りのみを行い、lookup_id、件数、一致するユーザーがいなかった識別子を返します。
  2. ユーザーを読み取る。 lookup_id を lookup として ユーザーを一覧表示 に渡します。返されるのは一致したユーザーのみで、識別子を送信した順序で並びます。

照合ルール

各識別子は、お客様のアプリケーション内で次の順序で照合されます。
  • 空の項目は除外され、重複は最初の項目を残して削除されます。
  • 1回のリクエストで送信できる項目は最大100,000件です。空の項目と重複を除いた後、識別子が1〜20,000件残っている必要があります。いずれかの上限を超えた場合は、400とcode: too_many_identifiersを返します。
  • 照合はお客様のアプリケーションのみを検索します。

リクエスト

レスポンス

一致したユーザーを取得

  • ユーザーは、リスト内の識別子の順に返されます。limit と offset でページ分割されます。1つのメールアドレスが複数のユーザーに一致する場合は、アカウントが古い順に並びます。
  • 結果は24時間保持され、アプリケーション専用です。その後、lookup は 404 と code: lookup_not_found を返します。リストを再度送信してください。

照会の結果を取得する

GET /v3/users/lookup/{lookup_id}/ は、照会と同じ本文に加えて identifiers を返します。この一覧は、送信した一覧から空欄と重複を取り除いたもので、送信時の順序を保っています。 照会の有効期限が切れている、存在しない、または別のアプリケーションに属している場合は、404 と code: lookup_not_found で応答します。

エラー

権限

APIキーには、ユーザーに対する読み取り権限が必要です。このエンドポイントがデータを変更することはありません。この権限のないキー、または失効したキーで呼び出すと、403が返されます。 キーのスコープは、APIキーごとに設定します。コンソールのロールと権限は、コンソール内でユーザーができる操作を決めるもので、APIトラフィックには評価されません。 コンソールでは、リストを検索するには、ユーザーの読み取り権限のみが必要です。

関連情報

承認

x-api-key
string
header
必須

Your application's API key, from Developers -> API keys in the Business Console. The primary key has full access. A named key can be scoped: none, read or write per resource, limited to some workflows or to approved sessions, to a list of IP addresses, and to an expiry date. 401 means the key is wrong, revoked or expired; 403 means no key was sent, the key has no access to this resource or action, or the request came from an address outside its IP list; 404 on a session route means the session is outside the key's workflows or statuses. A key without media access receives image, video and PDF URLs as null, and a key without sessions write receives session links and tokens as null. See https://docs.didit.me/console/api-keys.

ボディ

application/json
identifiers
string[]
必須

Each entry is a vendor_data value, a Didit user ID or a verified email. Send at most 100,000 entries. Blank entries are dropped and duplicates removed, keeping the first, and at most 20,000 identifiers must remain. Either limit exceeded is a 400 with code: too_many_identifiers, and an empty list is a 400 too.

Maximum array length: 100000
例:

レスポンス

The lookup was read. Use lookup_id with List users.

lookup_id
string<uuid>
必須

Pass it as lookup to List users.

requested
integer
必須

Identifiers read, after blanks and duplicates were removed.

found
integer
必須

Identifiers that matched at least one user.

not_found
object[]
必須
expires_at
string<date-time>
必須

When the result expires (24 hours after the lookup).

最終更新日 2026年11月20日