API Update Status Pengguna: Blokir atau Tandai

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"
}

Ikhtisar

Memindahkan entitas pengguna di antara ACTIVE, FLAGGED, dan BLOCKED. Lihat siklus hidup entitas untuk mesin status lengkap.

Kapan menggunakannya

Blokir pengguna setelah memastikan adanya penipuan atau pelanggaran kepatuhan.
Tandai pengguna sambil menunggu peninjauan manual tanpa memblokirnya secara total.
Buka blokir pengguna setelah remediasi berhasil.
Teruskan sinyal eksternal: misalnya, ketika mesin penipuan Anda memberi skor pengguna di atas ambang batas, pindahkan pengguna tersebut ke FLAGGED melalui endpoint ini.

Catatan

Nilai yang valid: ACTIVE, FLAGGED, BLOCKED. Nilai yang tidak valid mengembalikan 400.
Sertakan reason opsional (hingga 1000 karakter) untuk mencatat alasan perubahan status. Didit menyimpannya sebagai komentar pada entri perubahan status di aktivitas orang tersebut: comments[].comment pada pengguna, dan Aktivitas di Business Console. Alasan hanya dicatat ketika status benar-benar berubah.
Pengguna BLOCKED akan otomatis ditolak untuk semua sesi baru dan semua transaksi baru.
Mengirim webhook user.status.updated dengan previous_status dan status. Webhook tidak menyertakan reason.

Penegakan

Status	Dampak pada sesi baru	Dampak pada transaksi baru
`ACTIVE`	Alur normal	Alur normal
`FLAGGED`	Diizinkan, tetapi diarahkan ke `IN_REVIEW`	Diizinkan; dapat dieskalasi otomatis tergantung aturan
`BLOCKED`	Ditolak otomatis	Ditolak otomatis

Izin

Rahasia utama dan kunci API dengan akses penuh selalu dapat memanggil endpoint ini. Kunci dengan akses kustom memerlukan izin tulis Orang (users). Kunci yang dibatasi pada beberapa alur kerja atau hanya pada sesi yang disetujui tidak dapat mengakses endpoint ini. Peran dan izin di Console menentukan apa yang dapat dilakukan anggota tim di Console. Keduanya tidak dievaluasi untuk permintaan kunci API.

Terkait

Otorisasi

x-api-key

string

header

wajib

Kunci API aplikasi Anda, dari Developers -> API keys di Business Console. Kunci utama memiliki akses penuh. Kunci bernama dapat diberi cakupan: none, read, atau write per sumber daya, dibatasi pada beberapa alur kerja atau pada sesi yang disetujui, pada daftar alamat IP, dan pada tanggal kedaluwarsa. 401 berarti kuncinya salah, dicabut, atau kedaluwarsa; 403 berarti tidak ada kunci yang dikirimkan, kunci tidak memiliki akses ke sumber daya atau tindakan ini, atau permintaan datang dari alamat di luar daftar IP-nya; 404 pada rute sesi berarti sesi berada di luar alur kerja atau status kunci tersebut. Kunci tanpa akses media menerima URL gambar, video, dan PDF sebagai null, dan kunci tanpa izin tulis sesi menerima tautan sesi dan token sebagai null. Lihat https://docs.didit.me/console/api-keys.

Parameter Path

vendor_data

string

wajib

Pengidentifikasi unik Anda untuk pengguna.

Body

application/json

status

enum<string>

wajib

Status siklus hidup baru. BLOCKED juga menambahkan vendor_data ke daftar blokir sistem.

Opsi yang tersedia:

ACTIVE,

FLAGGED,

BLOCKED

reason

string | null

Alasan mengapa status berubah. Dicatat pada entri perubahan status aktivitas pengguna (comments[].comment, dan Activity di Business Console), hanya jika status benar-benar berubah. Webhook tidak menyertakannya.

Maximum string length: 1000

Respons

Status pengguna diperbarui. Rekor pengguna lengkap dikembalikan.

Detail pengguna lengkap. Memperluas UserListItem dengan metadata, komentar, dan updated_at.

didit_internal_id

string<uuid>

UUID internal yang stabil dari Didit untuk pengguna ini.

vendor_data

string | null

Pengidentifikasi unik Anda untuk pengguna ini (diteruskan saat membuat sesi). Nilai ini dapat berupa null jika tidak ada pengidentifikasi vendor yang diberikan.

display_name

string | null

Nama tampilan kustom yang Anda tetapkan

full_name

string | null

Nama lengkap yang diekstrak dari dokumen yang diverifikasi

date_of_birth

string<date> | null

effective_name

string | null

Nama terbaik yang tersedia: display_name jika disetel, selain itu full_name

status

enum<string>

Status siklus hidup rekaman pengguna (BUKAN status sesi). ACTIVE adalah default, FLAGGED menandai pengguna untuk perhatian manual, BLOCKED mencegah sesi baru untuk vendor_data ini.

Opsi yang tersedia:

ACTIVE,

FLAGGED,

BLOCKED

portrait_image_url

string | null

URL presigned untuk foto potret pengguna (kedaluwarsa setelah beberapa jam)

session_count

integer

Jumlah total sesi verifikasi untuk pengguna ini

approved_count

integer

Jumlah sesi yang disetujui

declined_count

integer

Jumlah sesi yang ditolak

in_review_count

integer

Jumlah sesi dalam peninjauan

issuing_states

string[]

Kode ISO 3166-1 alpha-3 dari negara penerbit yang terlihat pada dokumen ID pengguna yang disetujui ini, misalnya ["USA", "ESP"]. Berupa array kosong jika tidak ada.

approved_emails

string[]

Alamat email terverifikasi yang dikumpulkan dari sesi pengguna ini yang disetujui, contoh ["john@example.com"].

approved_phones

string[]

Nomor telepon terverifikasi yang dikumpulkan dari sesi pengguna ini yang disetujui, contoh ["+14155551234"].

features

object

Status per-fitur agregat di semua sesi pengguna ini. Kunci yang memungkinkan: ID_VERIFICATION, NFC, LIVENESS, FACE_MATCH, POA, QUESTIONNAIRE, EMAIL_VERIFICATION, PHONE, AML, IP_ANALYSIS, AGE_ESTIMATION, DATABASE_VALIDATION. Nilai yang memungkinkan: Approved, Declined, In Review, Not Finished, Resub Requested.

features_list

object[]

Data yang sama dengan features, sebagai array berurutan dari objek {feature, status}.

Show child attributes

last_session_at

string<date-time> | null

Cap waktu sesi terbaru

first_session_at

string<date-time> | null

Cap waktu sesi pertama

last_activity_at

string<date-time> | null

Cap waktu aktivitas terbaru pada pengguna ini (sesi, transaksi, perubahan status, pengeditan data, dll.).

​Ikhtisar

​Kapan menggunakannya

​Catatan

​Penegakan

​Izin

​Terkait

Otorisasi

Parameter Path

Body

Respons

Ikhtisar

Kapan menggunakannya

Catatan

Penegakan

Izin

Terkait