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

概要

ユーザーエンティティの変更可能なフィールドを更新します。検証済みのユーザー認証(KYC)セッションから反映されるフィールド(full_name、date_of_birth、portrait_image、集計カウンター、features)は読み取り専用です。

使用する場面

  • 独自のメタデータを更新する: ユーザーのレベルを変更する、タグを変更する、社内用のメモを記録する。
  • 名前を変更する: コンソールの社内向け表示用に、よりわかりやすいdisplay_nameを設定する。
  • 検証済みデータを上書きする(注意が必要): 手動での上書きは可能ですが、監査証跡に記録されます。

注意事項

  • URL内のvendor_dataはこのエンドポイントでは変更できません。キーを変更する必要がある場合は、新しいユーザーを作成し、古いユーザーを削除してください。
  • changed_fields配列を含むuser.data.updatedWebhookを送信するため、受信側は効率的に同期できます。
  • ここでのstatusの変更は、ユーザーステータスの更新と同様に動作します。 変更はそのユーザーのアクティビティに記録され、任意のreason(最大1000文字)がコメントとして残ります。また、BLOCKEDにするとvendor_dataがシステムのブロックリストに追加されます。 user.status.updatedWebhookにはreasonは含まれません。
  • 検証済みセッションが現在管理しているフィールドにPATCHリクエストを送信した場合、上書きは受け付けられますが、監査ログにフラグが付けられます。

権限

プライマリシークレットとフルアクセスのAPIキーは、常にこのエンドポイントを呼び出せます。 カスタムアクセスのキーには、People(users)の書き込み権限が必要です。 一部のワークフローまたは承認済みセッションに限定されたキーは、このエンドポイントにアクセスできません。 コンソールの役割と権限は、チームメンバーがコンソールで行える操作を決めるものです。 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ではありません)。

ボディ

application/json
full_name
string | null

ユーザーの氏名

Maximum string length: 512
display_name
string | null

このユーザーのカスタム表示名

date_of_birth
string<date> | null

YYYY-MM-DD形式の生年月日

status
enum<string>

ユーザーのライフサイクルステータス。変更はSTATUS_CHANGEDアクティビティとして記録されます。BLOCKEDにするとvendor_dataがシステムのブロックリストに追加されます(BLOCKEDから変更するとそのエントリは削除されます)。

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

ユーザーに付与する任意のJSONオブジェクト。更新時には既存のメタデータを完全に置き換えます。キーを追加したいだけの場合は、クライアント側でマージしてください。

approved_emails
string[]

このユーザーの認証済みメールアドレス。例: ["john@example.com"]。保存されているリストを完全に置き換えます。

approved_phones
string[]

このユーザーの認証済み電話番号。保存されているリストを完全に置き換えます。

issuing_states
string[]

発行国 (ISO 3166-1 alpha-3)。例: ["USA"]。保存されているリストを完全に置き換えます。

reason
string | null

ステータスが変更された理由。ユーザーのアクティビティ(comments[].comment、およびBusiness ConsoleのActivity)にあるステータス変更エントリに記録されます。記録されるのは、ステータスが実際に変わった場合のみです。Webhookには含まれません。

Maximum string length: 1000

レスポンス

ユーザーが更新されました。更新後のユーザーの完全なレコード(Get Userと同じ形式)が返されます。

ユーザーの完全な詳細。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日