> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.

# ユーザーデータモデル：ベンダーユーザーのスキーマ

> DiditのUserエンティティの全フィールドを解説します。本人情報、ステータス、KYCセッションの集計、生体認証、アクティビティのタイムスタンプ、メタデータを含みます。従量課金制です。

このページでは、Userエンティティのすべてのフィールドについて説明します。フィールドは、識別情報、ステータス、セッション集計、アクティビティのタイムスタンプ、メタデータの5つのグループに分かれます。

## 本人情報フィールド

| フィールド | 型 | 説明 |
| - | - | - |
| `uuid` | UUID | Diditが割り当てる主キー。不変かつ一意です。 |
| `didit_internal_id` | string | 人間が判読可能な内部識別子(APIレスポンスに含まれます)。 |
| `vendor_data` | string | お客様側のユーザー識別子。アプリケーションごとに一意です。[詳しくはこちら](https://docs.didit.me/ja/entities/vendor-data-linking.md)。 |
| `display_name` | string | コンソールに表示される上書き用の名前。未設定の場合は`full_name`または`vendor_data`が使われます。 |
| `full_name` | string | 直近で承認済みのユーザー認証(KYC)セッションの本人確認書類から反映される法的な氏名。 |
| `date_of_birth` | date (ISO 8601) | 直近で承認済みのユーザー認証(KYC)セッションから反映されます。 |
| `portrait_image` | URL | 直近で承認済みのライブネスチェックで取得したセルフィーの署名付きS3 URL。 |

> [!NOTE]
>
> `full_name`、`date_of_birth`、`portrait_image`は、検証済みのセッションから取得された場合は読み取り専用です。コンソールまたは`PATCH /v3/users/{vendor_data}/`で上書きできますが、手動での上書きには監査ログでフラグが付けられます。

## ステータス

| フィールド | 型 | 値 | 説明 |
| - | - | - | - |
| `status` | enum | `ACTIVE`, `FLAGGED`, `BLOCKED` | 今後のセッションと取引に対する適用を制御します。[ライフサイクル](https://docs.didit.me/ja/entities/lifecycle.md)を参照してください。 |

## セッション集計フィールド

これらのフィールドはDiditが計算し、セッションの完了に合わせてリアルタイムで更新されます。

| フィールド | 型 | 説明 |
| - | - | - |
| `session_count` | int | このユーザーに対してこれまでに作成されたセッションの総数 |
| `approved_count` | int | `APPROVED`で終了したセッション数 |
| `declined_count` | int | `DECLINED`で終了したセッション数 |
| `in_review_count` | int | 現在`IN_REVIEW`のセッション数 |
| `issuing_states[]` | ISO国コードの配列 | 全セッションを通じて検証されたすべての本人確認書類の発行国 |
| `approved_emails[]` | 文字列の配列 | [メールアドレス認証](https://docs.didit.me/ja/core-technology/email-verification/overview.md)で検証されたメールアドレス |
| `approved_phones[]` | 文字列の配列 | [電話番号検証](https://docs.didit.me/ja/core-technology/phone-verification/overview.md)で検証された電話番号 |
| `features` | object | 全セッションを通じた各機能の最新ステータス |

### `features`マップ

各セッションでは1つ以上の機能(本人確認、ライブネス、顔照合、AML、住所証明、NFCなど)が実行されます。`features`マップには、このユーザーにおける各機能の**最新**ステータスが格納されます。

```json theme={null}
{
  "id_verification": "APPROVED",
  "liveness": "APPROVED",
  "face_match": "APPROVED",
  "aml": "IN_REVIEW",
  "proof_of_address": "APPROVED",
  "nfc_verification": "NOT_FINISHED"
}
```

機能のステータス: `NOT_FINISHED`、`APPROVED`、`DECLINED`、`IN_REVIEW`、`EXPIRED`、`ABANDONED`、`RESUB_REQUESTED`。

すべてのセッションを走査せずに「このユーザーは現時点で完全に認証済みか」を判断するには、`features`マップを使うのが最も効率的です。

## アクティビティのタイムスタンプ

| フィールド | 型 | 更新タイミング |
| - | - | - |
| `first_session_at` | ISOタイムスタンプ | 最初のセッションが作成されたとき |
| `last_session_at` | ISOタイムスタンプ | 最新のセッションが作成または更新されたとき |
| `last_activity_at` | ISOタイムスタンプ | セッション、取引、ステータス、プロフィール、メモ、タグのいずれかに変更があったとき |
| `created_at` | ISOタイムスタンプ | エンティティの行が作成されたとき |
| `updated_at` | ISOタイムスタンプ | エンティティの行が最後に更新されたとき |

## メタデータ

| フィールド | 型 | 説明 |
| - | - | - |
| `metadata` | object (JSON) | お客様が管理する自由形式のJSON。社内タグ、レベル、登録経路などに使用します。 |
| `tags[]` | array | フィルターやグループ化のためにコンソール/APIで管理するタグ |

メタデータにスキーマはありません。Diditは書き込まれた内容をそのまま保存します。

## ユーザーレコードに保存されないリレーション

| リレーション | 取得方法 |
| - | - |
| セッション | `GET /v3/sessions?vendor_data=<value>` |
| 取引(申請者として) | `GET /v3/transactions/?vendor_data=<value>` |
| 取引(取引相手として) | コンソールで取引相手のvendor\_dataにより取引一覧をフィルタリング |
| 関連する企業(取締役/UBO) | コンソールのユーザー詳細ページに表示 |
| 顔の生体情報 | コンソール + Lists API |
| ブロックリストのエントリー | [Lists API](https://docs.didit.me/ja/management-api/lists/overview.md)でユーザーの識別子によりエントリーをフィルタリング |

## レスポンス例

```json theme={null}
{
  "uuid": "9c7d2a30-2f98-4d4f-9d2d-1a7c4b1e5b6a",
  "didit_internal_id": "U-2026-00042",
  "vendor_data": "user-42",
  "display_name": "Jane Doe",
  "full_name": "John Doe",
  "date_of_birth": "1990-01-01",
  "portrait_image": "https://<media-host>/...",
  "status": "ACTIVE",
  "session_count": 3,
  "approved_count": 2,
  "declined_count": 0,
  "in_review_count": 1,
  "issuing_states": ["US", "ES"],
  "approved_emails": ["jane@example.com"],
  "approved_phones": ["+14155550123"],
  "features": {
    "id_verification": "APPROVED",
    "liveness": "APPROVED",
    "face_match": "APPROVED",
    "aml": "IN_REVIEW"
  },
  "first_session_at": "2025-03-01T12:00:00Z",
  "last_session_at": "2026-04-10T09:00:00Z",
  "last_activity_at": "2026-04-16T10:00:00Z",
  "metadata": { "tier": "premium" }
}
```

## 次のステップ

> [card] [操作](https://docs.didit.me/ja/entities/users/operations.md)
>
> 作成、更新、ステータス変更、削除。

> [card] [KYC履歴](https://docs.didit.me/ja/entities/users/kyc-history.md)
>
> ユーザーに紐づくすべてのセッションを取得します。

> [card] [APIリファレンス](https://docs.didit.me/ja/management-api/users/get.md)
>
> GET /v3/users/{vendor_data}/ のスキーマ。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.