curl
curl -X GET 'https://verification.didit.me/v3/users/?limit=50' \
-H 'x-api-key: YOUR_API_KEY'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
for item in client.users.list():
print(item)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
for await (const item of didit.users.list()) {
console.log(item);
}ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
iter := client.Users.ListAutoPaging(ctx, didit.UsersListParams{})
for iter.Next() {
fmt.Printf("%+v\n", iter.Current())
}
if err := iter.Err(); err != nil {
log.Fatal(err)
}import me.didit.Didit;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
for (var item : client.users().list()) {
System.out.println(item);
}<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
foreach ($didit->users->list() as $item) {
print_r($item->toArray());
}require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
didit.users.list.auto_paging_each do |item|
puts item.to_h
endusing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
await foreach (var item in await client.Users.ListAsync())
{
Console.WriteLine(JsonSerializer.Serialize(item));
}{
"count": 2,
"next": null,
"previous": null,
"results": [
{
"didit_internal_id": "f4e5e1f2-94a9-4f86-8c16-2b7d9b4db418",
"vendor_data": "user-abc-123",
"display_name": null,
"full_name": "John Michael Doe",
"date_of_birth": "1990-05-15",
"effective_name": "John Michael Doe",
"status": "ACTIVE",
"portrait_image_url": "https://<media-host>/...",
"session_count": 3,
"approved_count": 2,
"declined_count": 0,
"in_review_count": 1,
"issuing_states": [
"USA"
],
"approved_emails": [
"john@example.com"
],
"approved_phones": [
"+14155551234"
],
"features": {
"ID_VERIFICATION": "Approved",
"LIVENESS": "Approved",
"FACE_MATCH": "Approved",
"AML": "Approved"
},
"features_list": [
{
"feature": "ID_VERIFICATION",
"status": "Approved"
},
{
"feature": "LIVENESS",
"status": "Approved"
},
{
"feature": "FACE_MATCH",
"status": "Approved"
},
{
"feature": "AML",
"status": "Approved"
}
],
"last_session_at": "2025-06-15T10:30:00Z",
"last_activity_at": "2025-06-15T10:30:00Z",
"first_session_at": "2025-06-01T08:00:00Z",
"tags": [
{
"uuid": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
"name": "VIP",
"color": "#2567FF"
}
],
"created_at": "2025-06-01T08:00:00Z"
},
{
"didit_internal_id": "6ed99d53-e8f5-4cf8-9ac1-4a506cb40f6b",
"vendor_data": null,
"display_name": "Jane S.",
"full_name": "Jane Elizabeth Smith",
"date_of_birth": "1985-11-22",
"effective_name": "Jane S.",
"status": "FLAGGED",
"portrait_image_url": null,
"session_count": 1,
"approved_count": 0,
"declined_count": 0,
"in_review_count": 1,
"issuing_states": [],
"approved_emails": [],
"approved_phones": [],
"features": {
"ID_VERIFICATION": "In Review"
},
"features_list": [
{
"feature": "ID_VERIFICATION",
"status": "In Review"
}
],
"last_session_at": "2025-06-20T14:00:00Z",
"last_activity_at": "2025-06-20T14:05:00Z",
"first_session_at": "2025-06-20T14:00:00Z",
"tags": [],
"created_at": "2025-06-20T14:00:00Z"
}
]
}{
"detail": "You must be authenticated with a valid access token to access this endpoint."
}{
"detail": "You do not have permission to perform this action."
}{
"detail": "Request was throttled. Expected available in 30 seconds."
}ユーザー
ユーザー一覧API:ベンダーのUserエンティティを取得
Didit APIで、アプリケーションのベンダーUserエンティティをすべて取得できます。ステータス、検索、日付でフィルターし、ユーザーのライフサイクルをプログラムで管理できます。
GET
/
v3
/
users
/
curl
curl -X GET 'https://verification.didit.me/v3/users/?limit=50' \
-H 'x-api-key: YOUR_API_KEY'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
for item in client.users.list():
print(item)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
for await (const item of didit.users.list()) {
console.log(item);
}ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
iter := client.Users.ListAutoPaging(ctx, didit.UsersListParams{})
for iter.Next() {
fmt.Printf("%+v\n", iter.Current())
}
if err := iter.Err(); err != nil {
log.Fatal(err)
}import me.didit.Didit;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
for (var item : client.users().list()) {
System.out.println(item);
}<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
foreach ($didit->users->list() as $item) {
print_r($item->toArray());
}require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
didit.users.list.auto_paging_each do |item|
puts item.to_h
endusing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
await foreach (var item in await client.Users.ListAsync())
{
Console.WriteLine(JsonSerializer.Serialize(item));
}{
"count": 2,
"next": null,
"previous": null,
"results": [
{
"didit_internal_id": "f4e5e1f2-94a9-4f86-8c16-2b7d9b4db418",
"vendor_data": "user-abc-123",
"display_name": null,
"full_name": "John Michael Doe",
"date_of_birth": "1990-05-15",
"effective_name": "John Michael Doe",
"status": "ACTIVE",
"portrait_image_url": "https://<media-host>/...",
"session_count": 3,
"approved_count": 2,
"declined_count": 0,
"in_review_count": 1,
"issuing_states": [
"USA"
],
"approved_emails": [
"john@example.com"
],
"approved_phones": [
"+14155551234"
],
"features": {
"ID_VERIFICATION": "Approved",
"LIVENESS": "Approved",
"FACE_MATCH": "Approved",
"AML": "Approved"
},
"features_list": [
{
"feature": "ID_VERIFICATION",
"status": "Approved"
},
{
"feature": "LIVENESS",
"status": "Approved"
},
{
"feature": "FACE_MATCH",
"status": "Approved"
},
{
"feature": "AML",
"status": "Approved"
}
],
"last_session_at": "2025-06-15T10:30:00Z",
"last_activity_at": "2025-06-15T10:30:00Z",
"first_session_at": "2025-06-01T08:00:00Z",
"tags": [
{
"uuid": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
"name": "VIP",
"color": "#2567FF"
}
],
"created_at": "2025-06-01T08:00:00Z"
},
{
"didit_internal_id": "6ed99d53-e8f5-4cf8-9ac1-4a506cb40f6b",
"vendor_data": null,
"display_name": "Jane S.",
"full_name": "Jane Elizabeth Smith",
"date_of_birth": "1985-11-22",
"effective_name": "Jane S.",
"status": "FLAGGED",
"portrait_image_url": null,
"session_count": 1,
"approved_count": 0,
"declined_count": 0,
"in_review_count": 1,
"issuing_states": [],
"approved_emails": [],
"approved_phones": [],
"features": {
"ID_VERIFICATION": "In Review"
},
"features_list": [
{
"feature": "ID_VERIFICATION",
"status": "In Review"
}
],
"last_session_at": "2025-06-20T14:00:00Z",
"last_activity_at": "2025-06-20T14:05:00Z",
"first_session_at": "2025-06-20T14:00:00Z",
"tags": [],
"created_at": "2025-06-20T14:00:00Z"
}
]
}{
"detail": "You must be authenticated with a valid access token to access this endpoint."
}{
"detail": "You do not have permission to perform this action."
}{
"detail": "Request was throttled. Expected available in 30 seconds."
}概要
認証済みアプリケーションのユーザーエンティティをページネーションされた一覧で返します。ユーザーをデータウェアハウスに同期する、アナリストの対応が必要なユーザーを見つける、表示名で検索する、といった用途に使用します。使用する場面
- 外部のBIツールやデータウェアハウスへのユーザーテーブルの定期同期。
- アナリスト用キュー:
status=FLAGGEDや古いlast_activity_atの値でフィルターし、レビュー用の受信トレイに振り分けます。 display_name、full_name、vendor_dataによるユーザーの検索。
フィルターとページネーション
| クエリパラメーター | 説明 |
|---|---|
status | ACTIVE、FLAGGED、BLOCKEDでフィルターします。 |
search | vendor_data、display_name、full_name、メールアドレス、電話番号に対する部分一致検索です。 |
country_code | issuing_states(ISO 3166-1 alpha-3)でフィルターします。 |
created_after, created_before | 作成日の期間(ISO 8601)です。 |
last_activity_after, last_activity_before | アクティビティの期間です。 |
page_size | 1~200。デフォルト: 50。 |
cursor | 前回のレスポンスで返されたページネーションカーソルです。 |
注意事項
- 各レスポンス項目には
didit_internal_idが含まれます。元のセッションまたは取引で指定されなかった場合、vendor_dataはnullになることがあります。 - このエンドポイントではカーソルベースのページネーションを使用します。呼び出し間で
nextカーソルを保持し、nextが空になったら停止してください。 - ユーザーレコードのすべてのフィールドについては、ユーザーデータモデルを参照してください。
権限
アプリケーションの有効なAPIキーであれば、どれでもこのエンドポイントを呼び出せます。DiditのAPIキーは 役割単位ではなく、アプリケーション単位です。Consoleの役割と権限 (list:usersなど)は、Consoleで人が何をできるかを決めるものであり、Management APIのトラフィックに対しては
評価されません。このエンドポイントを呼び出せる人を制御するには、アプリケーションのAPIキーを
読み取れる人を制御してください。
関連項目
承認
お客様のアプリケーションのAPIキーです。Business ConsoleのDevelopers -> API keysで取得できます。プライマリキーはフルアクセス権を持ちます。名前付きキーにはスコープを設定できます。リソースごとのアクセス権(なし、読み取り、書き込み)、一部のワークフローまたは承認済みセッションへの限定、IPアドレスのリストへの限定、有効期限の設定です。401は、キーが誤っている、失効している、または期限切れであることを意味します。403は、キーが送信されていない、キーにこのリソースやアクションへのアクセス権がない、またはIPリスト外のアドレスからリクエストが送信されたことを意味します。セッションのルートでの404は、セッションがキーのワークフローまたはステータスの対象外であることを意味します。メディアへのアクセス権がないキーでは、画像、動画、PDFのURLがnullで返されます。セッションの書き込み権限がないキーでは、セッションのリンクとトークンがnullで返されます。詳細は次を参照してください: https://docs.didit.me/console/api-keys
クエリパラメータ
ページサイズ。省略時は50です。強制される上限はありませんが、レイテンシーを抑えるためにページは小さく保ってください。
必須範囲:
1 <= x <= 1000000返す最初のレコードの0始まりのオフセットです。手動で計算するよりも、前のページのnextURLをたどる方法を推奨します。
必須範囲:
0 <= x <= 1000000最終更新日 2026年11月1日