API d'estat d'usuari: bloquejar o marcar

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

Visió general

Canvia una entitat d’usuari entre ACTIVE, FLAGGED i BLOCKED. Consulta el cicle de vida de les entitats per veure la màquina d’estats completa.

Quan utilitzar-lo

Bloqueja un usuari després de confirmar un frau o un incompliment normatiu.
Marca un usuari com a pendent de revisió manual sense bloquejar-lo del tot.
Desbloqueja un usuari després d’una remediació satisfactòria.
Propaga senyals externs: p. ex., quan el teu propi motor de frau puntua un usuari per sobre d’un llindar, mou-lo a FLAGGED mitjançant aquest endpoint.

Notes

Valors vàlids: ACTIVE, FLAGGED i BLOCKED. Els valors no vàlids retornen 400.
Pots passar un reason opcional (fins a 1000 caràcters) per registrar el motiu del canvi d’estat. Didit el guarda com a comentari de l’entrada de canvi d’estat a l’activitat de la persona: comments[].comment a l’usuari i Activitat a la Business Console. Només es registra quan l’estat canvia realment.
Els usuaris BLOCKED tenen totes les sessions noves rebutjades automàticament i totes les transaccions noves rebutjades automàticament.
Emet un webhook user.status.updated amb previous_status i status. El webhook no inclou reason.

Aplicació

Estat	Efecte sobre les sessions noves	Efecte sobre les transaccions noves
`ACTIVE`	Flux normal	Flux normal
`FLAGGED`	Permeses però dirigides a `IN_REVIEW`	Permeses; poden escalar automàticament segons les regles
`BLOCKED`	Rebutjades automàticament	Rebutjades automàticament

Permisos

El secret principal i les claus d’API amb accés complet sempre poden cridar aquest endpoint. Una clau amb accés personalitzat necessita permís d’escriptura de Persones (users). Una clau limitada a alguns fluxos de treball o a sessions aprovades no pot arribar a aquest endpoint. Els rols i permisos de la Console determinen què pot fer un membre de l’equip a la Console. No s’avaluen per a les sol·licituds amb clau d’API.

Relacionat

Autoritzacions

x-api-key

string

header

requerit

La clau d'API de la teva aplicació, des de Developers -> API keys a la Business Console. La clau primària té accés complet. Una clau amb nom pot tenir l'abast limitat: cap, lectura o escriptura per recurs, limitada a determinats fluxos de treball o a sessions aprovades, a una llista d'adreces IP i a una data de caducitat. 401 significa que la clau és incorrecta, revocada o caducada; 403 significa que no s'ha enviat cap clau, que la clau no té accés a aquest recurs o acció, o que la sol·licitud prové d'una adreça fora de la seva llista d'IP; 404 en una ruta de sessió significa que la sessió està fora dels fluxos de treball o estats de la clau. Una clau sense accés a fitxers multimèdia rep els URL d'imatge, vídeo i PDF com a null, i una clau sense permís d'escriptura de sessions rep els enllaços de sessió i els tokens com a null. Consulta https://docs.didit.me/console/api-keys.

Paràmetres de ruta

vendor_data

string

requerit

El teu identificador únic per a l'usuari.

Cos

application/json

status

enum<string>

requerit

Nou estat del cicle de vida. BLOCKED també afegeix el vendor_data a la llista de bloqueig del sistema.

Opcions disponibles:

ACTIVE,

FLAGGED,

BLOCKED

reason

string | null

Per què ha canviat l'estat. Es registra a l'entrada de canvi d'estat de l'activitat de l'usuari (comments[].comment, i Activitat a la Business Console), només quan l'estat canvia realment. Els webhooks no l'inclouen.

Maximum string length: 1000

Resposta

Estat de l'usuari actualitzat. Es retorna el registre complet de l'usuari.

Detall complet de l'usuari. Amplia UserListItem amb metadades, comentaris i updated_at.

didit_internal_id

string<uuid>

UUID intern estable de Didit per a aquest usuari.

vendor_data

string | null

El teu identificador únic per a aquest usuari (passat en crear sessions). Pot ser nul quan no s'ha proporcionat cap identificador de proveïdor.

display_name

string | null

Nom visible personalitzat definit per tu

full_name

string | null

Nom complet extret dels documents verificats

date_of_birth

string<date> | null

effective_name

string | null

Millor nom disponible: display_name si està definit, en cas contrari full_name

status

enum<string>

Estat del cicle de vida del registre d'usuari (NO és un estat de la sessió). ACTIVE és el valor per defecte, FLAGGED marca l'usuari per a atenció manual, BLOCKED impedeix noves sessions per a aquest vendor_data.

Opcions disponibles:

ACTIVE,

FLAGGED,

BLOCKED

portrait_image_url

string | null

URL presignada de la foto de retrat de l'usuari (caduca al cap d'unes hores)

session_count

integer

Nombre total de sessions de verificació per a aquest usuari

approved_count

integer

Nombre de sessions aprovades

declined_count

integer

Nombre de sessions rebutjades

in_review_count

integer

Nombre de sessions en revisió

issuing_states

string[]

Codis ISO 3166-1 alpha-3 dels països emissors que consten als documents d'identitat aprovats d'aquest usuari, p. ex. ["USA", "ESP"]. Matriu buida si no n'hi ha cap.

approved_emails

string[]

Adreces de correu electrònic verificades recollides de les sessions aprovades d'aquest usuari, p. ex. ["john@example.com"].

approved_phones

string[]

Números de telèfon verificats recollits de les sessions aprovades d'aquest usuari, p. ex. ["+14155551234"].

features

object

Estat agregat per funcionalitat a totes les sessions d'aquest usuari. Claus possibles: ID_VERIFICATION, NFC, LIVENESS, FACE_MATCH, POA, QUESTIONNAIRE, EMAIL_VERIFICATION, PHONE, AML, IP_ANALYSIS, AGE_ESTIMATION, DATABASE_VALIDATION. Valors possibles: Approved, Declined, In Review, Not Finished, Resub Requested.

features_list

object[]

Les mateixes dades que features, com una llista ordenada d'objectes {feature, status}.

Show child attributes

last_session_at

string<date-time> | null

Marca de temps de la sessió més recent

first_session_at

string<date-time> | null

Marca de temps de la primera sessió

last_activity_at

string<date-time> | null

Marca de temps de l'activitat més recent d'aquest usuari (sessió, transacció, canvi d'estat, edició de dades, etc.).

​Visió general

​Quan utilitzar-lo

​Notes

​Aplicació

​Permisos

​Relacionat

Autoritzacions

Paràmetres de ruta

Cos

Resposta

Visió general

Quan utilitzar-lo

Notes

Aplicació

Permisos

Relacionat