Benutzerstatus aktualisieren API: sperren oder markieren

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

Überblick

Wechselt eine Benutzer-Entität zwischen ACTIVE, FLAGGED und BLOCKED. Den vollständigen Zustandsautomaten finden Sie im Lebenszyklus der Entität.

Wann Sie den Endpoint verwenden sollten

Einen Benutzer sperren, nachdem Betrug oder ein Compliance-Verstoß bestätigt wurde.
Einen Benutzer markieren, bis eine manuelle Prüfung abgeschlossen ist, ohne ihn vollständig zu sperren.
Blockierung aufheben: Heben Sie die Blockierung eines Benutzers nach erfolgreicher Behebung auf.
Externe Signale weitergeben: Wenn Ihre eigene Betrugserkennung einen Benutzer mit einem Wert über dem Schwellenwert bewertet, setzen Sie ihn über diesen Endpoint auf FLAGGED.

Hinweise

Gültige Werte: ACTIVE, FLAGGED, BLOCKED. Ungültige Werte geben 400 zurück.
Übergeben Sie optional einen reason (bis zu 1000 Zeichen), um festzuhalten, warum sich der Status geändert hat. Didit speichert ihn als Kommentar des Eintrags zur Statusänderung in der Aktivität der Person: comments[].comment beim Benutzer und Aktivität in der Business Console. Er wird nur gespeichert, wenn sich der Status tatsächlich ändert.
Bei Benutzern mit dem Status BLOCKED werden alle neuen Sitzungen und alle neuen Transaktionen automatisch abgelehnt.
Es wird ein Webhook-Ereignis user.status.updated ausgelöst, das previous_status und status enthält. Der Webhook enthält kein reason.

Durchsetzung

Status	Auswirkung auf neue Sitzungen	Auswirkung auf neue Transaktionen
`ACTIVE`	Normaler Ablauf	Normaler Ablauf
`FLAGGED`	Erlaubt, wird aber an `IN_REVIEW` weitergeleitet	Erlaubt; kann je nach Regeln automatisch eskaliert werden
`BLOCKED`	Automatisch abgelehnt	Automatisch abgelehnt

Berechtigungen

Das primäre Secret und API-Schlüssel mit vollem Zugriff können diesen Endpoint immer aufrufen. Ein API-Schlüssel mit benutzerdefiniertem Zugriff benötigt Schreibzugriff auf Personen (users). Ein Schlüssel, der auf bestimmte Workflows oder auf genehmigte Sitzungen beschränkt ist, kann diesen Endpoint nicht erreichen. Die Rollen und Berechtigungen der Console bestimmen, was ein Teammitglied in der Console tun darf. Bei Anfragen mit API-Schlüsseln werden sie nicht ausgewertet.

Verwandte Themen

Autorisierungen

x-api-key

string

header

erforderlich

Der API-Schlüssel Ihrer Anwendung, aus Entwickler -> API-Schlüssel in der Business Console. Der Primärschlüssel hat Vollzugriff. Ein benannter Schlüssel kann im Geltungsbereich eingeschränkt werden: keine, Lese- oder Schreibberechtigung pro Ressource, beschränkt auf bestimmte Workflows oder genehmigte Sitzungen, auf eine Liste von IP-Adressen und auf ein Ablaufdatum. 401 bedeutet, dass der Schlüssel falsch, widerrufen oder abgelaufen ist; 403 bedeutet, dass kein Schlüssel gesendet wurde, der Schlüssel keinen Zugriff auf diese Ressource oder Aktion hat oder die Anfrage von einer Adresse außerhalb seiner IP-Liste stammte; 404 bei einer Sitzungsroute bedeutet, dass die Sitzung außerhalb der Workflows oder Status des Schlüssels liegt. Ein Schlüssel ohne Medienzugriff erhält Bild-, Video- und PDF-URLs als null, und ein Schlüssel ohne Schreibberechtigung für Sitzungen erhält Sitzungslinks und Token als null. Siehe https://docs.didit.me/console/api-keys.

Pfadparameter

vendor_data

string

erforderlich

Ihre eindeutige Kennung für den Benutzer.

Body

application/json

status

enum<string>

erforderlich

Neuer Lebenszyklusstatus. BLOCKED fügt die vendor_data außerdem zur System-Sperrliste hinzu.

Verfügbare Optionen:

ACTIVE,

FLAGGED,

BLOCKED

reason

string | null

Warum sich der Status geändert hat. Wird im Statusänderungseintrag der Benutzeraktivität (comments[].comment und Activity in der Business Console) erfasst, nur wenn sich der Status tatsächlich ändert. Webhooks übertragen dies nicht.

Maximum string length: 1000

Antwort

Benutzerstatus aktualisiert. Vollständiger Benutzerdatensatz zurückgegeben.

Vollständige Benutzerdetails. Erweitert UserListItem um Metadaten, Kommentare und updated_at.

didit_internal_id

string<uuid>

Didits stabile interne UUID für diesen Benutzer.

vendor_data

string | null

Ihre eindeutige Kennung für diesen Benutzer (beim Erstellen von Sitzungen übergeben). Dies kann null sein, wenn keine Vendor-Kennung angegeben wurde.

display_name

string | null

Von Ihnen festgelegter benutzerdefinierter Anzeigename

full_name

string | null

Aus verifizierten Dokumenten extrahierter vollständiger Name

date_of_birth

string<date> | null

effective_name

string | null

Bester verfügbarer Name: display_name, falls gesetzt, andernfalls full_name

status

enum<string>

Lebenszyklusstatus des Benutzerdatensatzes (KEIN Sitzungsstatus). ACTIVE ist der Standard, FLAGGED markiert den Benutzer für manuelle Prüfung, BLOCKED verhindert neue Sitzungen für dieses vendor_data.

Verfügbare Optionen:

ACTIVE,

FLAGGED,

BLOCKED

portrait_image_url

string | null

Vorsignierte URL des Porträtfotos des Benutzers (läuft nach wenigen Stunden ab)

session_count

integer

Gesamtzahl der Verifizierungssitzungen für diesen Benutzer

approved_count

integer

Anzahl der genehmigten Sitzungen

declined_count

integer

Anzahl der abgelehnten Sitzungen

in_review_count

integer

Anzahl der Sitzungen in Prüfung

issuing_states

string[]

ISO 3166-1-Alpha-3-Codes der Ausstellungsländer, die auf den genehmigten Ausweisdokumenten dieses Benutzers gefunden wurden, z. B. ["USA", "ESP"]. Leeres Array, wenn keine vorhanden sind.

approved_emails

string[]

Verifizierte E-Mail-Adressen, die aus den genehmigten Sitzungen dieses Benutzers erfasst wurden, z. B. ["john@example.com"].

approved_phones

string[]

Verifizierte Telefonnummern, die aus den genehmigten Sitzungen dieses Benutzers erfasst wurden, z. B. ["+14155551234"].

features

object

Aggregierter Status pro Funktion über alle Sitzungen dieses Benutzers hinweg. Mögliche Schlüssel: ID_VERIFICATION, NFC, LIVENESS, FACE_MATCH, POA, QUESTIONNAIRE, EMAIL_VERIFICATION, PHONE, AML, IP_ANALYSIS, AGE_ESTIMATION, DATABASE_VALIDATION. Mögliche Werte: Approved, Declined, In Review, Not Finished, Resub Requested.

features_list

object[]

Dieselben Daten wie features, als geordnetes Array von {feature, status}-Objekten.

Show child attributes

last_session_at

string<date-time> | null

Zeitstempel der letzten Sitzung

first_session_at

string<date-time> | null

Zeitstempel der ersten Sitzung

last_activity_at

string<date-time> | null

Zeitstempel der letzten Aktivität bei diesem Benutzer (Sitzung, Transaktion, Statusänderung, Datenbearbeitung usw.).

​Überblick

​Wann Sie den Endpoint verwenden sollten

​Hinweise

​Durchsetzung

​Berechtigungen

​Verwandte Themen

Autorisierungen

Pfadparameter

Body

Antwort

Überblick

Wann Sie den Endpoint verwenden sollten

Hinweise

Durchsetzung

Berechtigungen

Verwandte Themen