メインコンテンツへスキップ
GET
curl

概要

vendor_dataをキーとして、単一のユーザーエンティティを返します。レスポンスには、Diditの安定した内部識別子であるdidit_internal_idが含まれます。

使用するタイミング

  • 確認: ユーザーの現在の認証状態を確認します。featuresマップには、すべての機能の最新ステータスが1つのオブジェクトにまとめられています。
  • 詳細ビュー: 自社のUIで表示する前に、必要に応じてプロフィールを取得します。
  • リスクスコアリング: セッションのカウンターとfeaturesを組み合わせて、自社側で各ユーザーをスコアリングします。

注意事項

  • URL内のvendor_dataは大文字と小文字が区別されます。
  • そのvendor_dataを持つユーザーがアプリケーション内に存在しない場合は404を返します。
  • 集計カウンター(session_count、approved_count、declined_count、in_review_count)は、セッションの完了に合わせてリアルタイムで更新されます。
  • すべてのフィールドについてはユーザーのデータモデルを参照してください。

権限

アプリケーションの有効なAPIキーであれば、どれでもこのエンドポイントを呼び出せます。DiditのAPIキーは 役割単位ではなく、アプリケーション単位です。Consoleの役割と権限 (read:usersなど)は、Consoleで人が何をできるかを決めるものであり、Management APIのトラフィックに対しては 評価されません。このエンドポイントを呼び出せる人を制御するには、アプリケーションのAPIキーを 閲覧できる人を制御してください。

関連情報

承認

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

パスパラメータ

vendor_data
string
必須

ユーザーに対するお客様独自の識別子です。自由形式の文字列(UUIDではありません)です。このユーザーを最初に登録したセッションの作成時にvendor_dataとして渡した値と同じで、送信されたとおりに完全一致で照合されます。

レスポンス

メタデータ、コメント/アクティビティログ、集計されたセッションデータを含むユーザーの完全な詳細。

ユーザーの完全な詳細。UserListItemを拡張し、メタデータ、コメント、updated_atを追加します。

didit_internal_id
string<uuid>

このユーザーに対するDiditの安定した内部UUIDです。

vendor_data
string | null

このユーザーに対するお客様独自の識別子です(セッション作成時に渡されたもの)。ベンダー識別子が指定されなかった場合はnullになることがあります。

display_name
string | null

お客様が設定したカスタム表示名

full_name
string | null

認証済みの書類から抽出された氏名

date_of_birth
string<date> | null
effective_name
string | null

利用可能な最適な名前:display_nameが設定されていればそれを、設定されていなければfull_nameを使用

status
enum<string>

ユーザーレコードのライフサイクルステータス(セッションのステータスではありません)。ACTIVEがデフォルトで、FLAGGEDはユーザーを手動での確認対象としてマークし、BLOCKEDはこのvendor_dataでの新規セッションを禁止します。

利用可能なオプション:
ACTIVE,
FLAGGED,
BLOCKED
portrait_image_url
string | null

ユーザーの顔写真の署名付きURL(数時間後に期限切れ)

session_count
integer

このユーザーの認証セッションの総数

approved_count
integer

承認済みセッションの数

declined_count
integer

却下されたセッションの数

in_review_count
integer

レビュー中のセッション数

issuing_states
string[]

このユーザーの承認済み身分証明書類で確認された発行国のISO 3166-1 alpha-3コード。例: ["USA", "ESP"]。該当がない場合は空の配列です。

approved_emails
string[]

このユーザーの承認済みセッションから収集された認証済みメールアドレス。例: ["john@example.com"]。

approved_phones
string[]

このユーザーの承認済みセッションから収集された認証済み電話番号。例: ["+14155551234"]。

features
object

このユーザーのすべてのセッションを通じた、機能ごとの集計ステータスです。取り得るキーはID_VERIFICATION、NFC、LIVENESS、FACE_MATCH、POA、QUESTIONNAIRE、EMAIL_VERIFICATION、PHONE、AML、IP_ANALYSIS、AGE_ESTIMATION、DATABASE_VALIDATIONです。取り得る値はApproved、Declined、In Review、Not Finished、Resub Requestedです。

features_list
object[]

featuresと同じデータを、{feature, status}オブジェクトの順序付き配列で表したもの。

last_session_at
string<date-time> | null

直近のセッションの日時

first_session_at
string<date-time> | null

最初のセッションの日時

last_activity_at
string<date-time> | null

このユーザーの直近のアクティビティ(セッション、取引、ステータス変更、データ編集など)の日時。

tags
object[]

タグの割り当て。注意: 詳細レスポンスでは、各エントリはタグのリンクオブジェクト({uuid, tag: {...}, added_by_email, added_by_name, created_at})であり、一覧レスポンスで使われるフラットな{uuid, name, color}形式とは異なります。

created_at
string<date-time>
metadata
object

このユーザーに付加したカスタムメタデータJSON。デフォルトは{}です。

comments
object[]

このユーザーのアクティビティログとコメント(ステータスの変更、プロフィールの編集、手動メモ)。

updated_at
string<date-time>
最終更新日 2026年11月1日