ユーザーステータス更新API：ブロック・フラグ設定

curl

curl -X PATCH 'https://verification.didit.me/v3/users/user-abc-123/update-status/' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"status": "BLOCKED"}'

import Didit from "@didit-protocol/sdk-node";

// Reads DIDIT_API_KEY.
const didit = new Didit();

const result = await didit.users.updateStatus("user-123", {
  status: "ACTIVE",
});
console.log(result);

ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

result, err := client.Users.UpdateStatus(ctx, "user-123", didit.UsersUpdateStatusParams{
	Status: "ACTIVE",
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)

import me.didit.Didit;
import me.didit.types.EntityStatusUpdateRequest;
import me.didit.types.UsersUpdateStatusParams;

// Reads DIDIT_API_KEY.
Didit client = new Didit();

var result = client.users().updateStatus("user-123", UsersUpdateStatusParams.builder()
        .status(EntityStatusUpdateRequest.Status.of("ACTIVE"))
        .build());
System.out.println(result);

<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

// Reads DIDIT_API_KEY.
$didit = new DiditClient();

$result = $didit->users->updateStatus('user-123', [
    'status' => 'ACTIVE',
]);
print_r($result->toArray());

using System;
using System.Text.Json;
using Didit;

// Reads DIDIT_API_KEY.
using var client = new DiditClient();

var result = await client.Users.UpdateStatusAsync("user-123", new UsersUpdateStatusParams
{
    Status = "ACTIVE",
});
Console.WriteLine(JsonSerializer.Serialize(result));

{
  "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": "BLOCKED",
  "metadata": {
    "tier": "premium",
    "source": "website"
  },
  "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",
      "tag": {
        "uuid": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b",
        "name": "VIP",
        "color": "#2567FF",
        "description": null,
        "source": "custom",
        "created_at": "2025-05-01T09:00:00Z",
        "updated_at": "2025-05-01T09:00:00Z"
      },
      "added_by_email": "analyst@acme.com",
      "added_by_name": "Jane Analyst",
      "created_at": "2025-06-02T11:00:00Z"
    }
  ],
  "comments": [
    {
      "uuid": "c1111111-2222-4333-8444-555555555555",
      "comment_type": "STATUS_CHANGED",
      "comment": "Chargeback fraud pattern confirmed",
      "actor_email": null,
      "actor_name": null,
      "previous_status": "ACTIVE",
      "new_status": "BLOCKED",
      "previous_value": null,
      "new_value": null,
      "changed_fields": [],
      "metadata": null,
      "mentioned_emails": [],
      "created_at": "2025-06-15T10:30:00Z"
    }
  ],
  "created_at": "2025-06-01T08:00:00Z",
  "updated_at": "2025-06-15T10:30:00Z"
}

PATCH

users

{vendor_data}

update-status

curl

curl -X PATCH 'https://verification.didit.me/v3/users/user-abc-123/update-status/' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"status": "BLOCKED"}'

import Didit from "@didit-protocol/sdk-node";

// Reads DIDIT_API_KEY.
const didit = new Didit();

const result = await didit.users.updateStatus("user-123", {
  status: "ACTIVE",
});
console.log(result);

ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

result, err := client.Users.UpdateStatus(ctx, "user-123", didit.UsersUpdateStatusParams{
	Status: "ACTIVE",
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)

import me.didit.Didit;
import me.didit.types.EntityStatusUpdateRequest;
import me.didit.types.UsersUpdateStatusParams;

// Reads DIDIT_API_KEY.
Didit client = new Didit();

var result = client.users().updateStatus("user-123", UsersUpdateStatusParams.builder()
        .status(EntityStatusUpdateRequest.Status.of("ACTIVE"))
        .build());
System.out.println(result);

<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

// Reads DIDIT_API_KEY.
$didit = new DiditClient();

$result = $didit->users->updateStatus('user-123', [
    'status' => 'ACTIVE',
]);
print_r($result->toArray());

using System;
using System.Text.Json;
using Didit;

// Reads DIDIT_API_KEY.
using var client = new DiditClient();

var result = await client.Users.UpdateStatusAsync("user-123", new UsersUpdateStatusParams
{
    Status = "ACTIVE",
});
Console.WriteLine(JsonSerializer.Serialize(result));

{
  "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": "BLOCKED",
  "metadata": {
    "tier": "premium",
    "source": "website"
  },
  "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",
      "tag": {
        "uuid": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b",
        "name": "VIP",
        "color": "#2567FF",
        "description": null,
        "source": "custom",
        "created_at": "2025-05-01T09:00:00Z",
        "updated_at": "2025-05-01T09:00:00Z"
      },
      "added_by_email": "analyst@acme.com",
      "added_by_name": "Jane Analyst",
      "created_at": "2025-06-02T11:00:00Z"
    }
  ],
  "comments": [
    {
      "uuid": "c1111111-2222-4333-8444-555555555555",
      "comment_type": "STATUS_CHANGED",
      "comment": "Chargeback fraud pattern confirmed",
      "actor_email": null,
      "actor_name": null,
      "previous_status": "ACTIVE",
      "new_status": "BLOCKED",
      "previous_value": null,
      "new_value": null,
      "changed_fields": [],
      "metadata": null,
      "mentioned_emails": [],
      "created_at": "2025-06-15T10:30:00Z"
    }
  ],
  "created_at": "2025-06-01T08:00:00Z",
  "updated_at": "2025-06-15T10:30:00Z"
}

概要

UserエンティティのステータスをACTIVE、FLAGGED、BLOCKEDの間で変更します。状態遷移の全体像はエンティティのライフサイクルを参照してください。

使用する場面

不正やコンプライアンス違反を確認した後にユーザーをブロックする。
完全にブロックせず、手動レビューの結果が出るまでユーザーにフラグを付ける。
是正措置が完了した後にユーザーのブロックを解除する。
外部シグナルを反映する。たとえば、自社の不正検知エンジンがユーザーにしきい値を超えるスコアを付けた場合に、このエンドポイントでそのユーザーのステータスをFLAGGEDに変更します。

注意事項

有効な値はACTIVE、FLAGGED、BLOCKEDです。無効な値を指定すると400が返されます。
ステータスを変更した理由を記録するには、任意のreason(最大1000文字)を渡します。 Diditはこれを、そのユーザーのアクティビティにおけるステータス変更エントリーのコメントとして保持します。ユーザーのcomments[].commentおよびBusiness ConsoleのActivityに記録されます。記録されるのは、ステータスが実際に変更された場合のみです。
BLOCKEDのユーザーについては、新規セッションはすべて自動的に却下され、新規取引もすべて自動的に却下されます。
previous_statusとstatusを含むuser.status.updated Webhookを送信します。このWebhookにはreasonは含まれません。

適用

ステータス	新規セッションへの影響	新規取引への影響
`ACTIVE`	通常のフロー	通常のフロー
`FLAGGED`	許可されるが`IN_REVIEW`に振り分けられる	許可される。ルールによっては自動的にエスカレーションされる場合がある
`BLOCKED`	自動的に却下	自動的に却下

権限

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

必須

ユーザーに対するお客様独自の識別子です。

ボディ

application/json

status

enum<string>

必須

新しいライフサイクルステータス。BLOCKEDを指定すると、vendor_dataもシステムのブロックリストに追加されます。

利用可能なオプション:

ACTIVE,

FLAGGED,

BLOCKED

reason

string | null

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

Maximum string length: 1000

レスポンス

ユーザーステータスが更新されました。ユーザーの完全なレコードが返されます。

ユーザーの完全な詳細。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}オブジェクトの順序付き配列で表したもの。

Show child attributes

last_session_at

string<date-time> | null

直近のセッションの日時

first_session_at

string<date-time> | null

最初のセッションの日時

last_activity_at

string<date-time> | null

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

​概要

​使用する場面

​注意事項

​適用

​権限

​関連項目

承認

パスパラメータ

ボディ

レスポンス

概要

使用する場面

注意事項

適用

権限

関連項目