API para actualizar estado del usuario: bloquear 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"
}

Descripción general

Cambia el estado de una entidad de usuario entre ACTIVE, FLAGGED y BLOCKED. Consulta el ciclo de vida de las entidades para ver la máquina de estados completa.

Cuándo usarlo

Bloquear a un usuario tras confirmar un fraude o un incumplimiento normativo.
Marcar a un usuario a la espera de una revisión manual, sin bloquearlo por completo.
Desbloquear a un usuario tras una subsanación exitosa.
Propagar señales externas: por ejemplo, cuando tu propio motor de fraude asigna a un usuario una puntuación por encima de un umbral, pásalo a FLAGGED mediante este endpoint.

Notas

Valores válidos: ACTIVE, FLAGGED, BLOCKED. Los valores no válidos devuelven 400.
Envía un reason opcional (hasta 1000 caracteres) para registrar por qué cambió el estado. Didit lo guarda como comentario de la entrada de cambio de estado en la actividad de la persona: comments[].comment en el usuario y Activity en la Business Console. Solo se registra cuando el estado cambia realmente.
Para los usuarios BLOCKED, todas las sesiones nuevas y todas las transacciones nuevas se rechazan automáticamente.
Emite un webhook user.status.updated con previous_status y status. El webhook no incluye reason.

Aplicación de medidas

Estado	Efecto en las sesiones nuevas	Efecto en las transacciones nuevas
`ACTIVE`	Flujo normal	Flujo normal
`FLAGGED`	Permitidas, pero se envían a `IN_REVIEW`	Permitidas; pueden escalarse automáticamente según las reglas
`BLOCKED`	Rechazadas automáticamente	Rechazadas automáticamente

Permisos

El secreto principal y las claves de API con acceso completo siempre pueden llamar a este endpoint. Una clave con acceso personalizado necesita acceso de escritura a Personas (users). Una clave limitada a algunos flujos o a sesiones aprobadas no puede acceder a este endpoint. Los roles y permisos de la Console determinan lo que un miembro del equipo puede hacer en la Console. No se evalúan en las solicitudes con clave de API.

Relacionado

Autorizaciones

x-api-key

string

header

requerido

La clave de API de tu aplicación, que encontrarás en Developers -> API keys en la Business Console. La clave principal tiene acceso completo. Una clave con nombre puede tener un alcance limitado: ninguno, lectura o escritura por recurso, limitada a algunos flujos o a sesiones aprobadas, a una lista de direcciones IP y a una fecha de caducidad. 401 significa que la clave es incorrecta, se revocó o expiró; 403 significa que no se envió ninguna clave, que la clave no tiene acceso a este recurso o acción, o que la solicitud provino de una dirección fuera de su lista de IP; 404 en una ruta de sesión significa que la sesión está fuera de los flujos o estados de la clave. Una clave sin acceso a contenido multimedia recibe las URL de imágenes, videos y PDF como null, y una clave sin permiso de escritura en sesiones recibe los enlaces y tokens de sesión como null. Consulta https://docs.didit.me/console/api-keys.

Parámetros de ruta

vendor_data

string

requerido

Tu identificador único del usuario.

Cuerpo

application/json

status

enum<string>

requerido

Nuevo estado del ciclo de vida. BLOCKED también añade el vendor_data a la lista de bloqueo del sistema.

Opciones disponibles:

ACTIVE,

FLAGGED,

BLOCKED

reason

string | null

Por qué cambió el estado. Se registra en la entrada de cambio de estado de la actividad del usuario (comments[].comment y Activity en Business Console), solo cuando el estado cambia realmente. Los webhooks no lo incluyen.

Maximum string length: 1000

Respuesta

Estado del usuario actualizado. Se devuelve el registro completo del usuario.

Detalle completo del usuario. Amplía UserListItem con metadatos, comentarios y updated_at.

didit_internal_id

string<uuid>

UUID interno estable de Didit para este usuario.

vendor_data

string | null

Tu identificador único de este usuario (el que se envía al crear sesiones). Puede ser null si no se proporcionó ningún identificador propio.

display_name

string | null

Nombre visible personalizado que has definido

full_name

string | null

Nombre completo extraído de los documentos verificados

date_of_birth

string<date> | null

effective_name

string | null

Mejor nombre disponible: display_name si está definido; si no, full_name

status

enum<string>

Estado del ciclo de vida del registro del usuario (NO es un estado de sesión). ACTIVE es el valor predeterminado, FLAGGED marca al usuario para atención manual y BLOCKED impide nuevas sesiones para este vendor_data.

Opciones disponibles:

ACTIVE,

FLAGGED,

BLOCKED

portrait_image_url

string | null

URL prefirmada de la foto de retrato del usuario (caduca al cabo de unas horas)

session_count

integer

Número total de sesiones de verificación de este usuario

approved_count

integer

Número de sesiones aprobadas

declined_count

integer

Número de sesiones rechazadas

in_review_count

integer

Número de sesiones en revisión

issuing_states

string[]

Códigos ISO 3166-1 alpha-3 de los países emisores que figuran en los documentos de identidad aprobados de este usuario, p. ej., ["USA", "ESP"]. Array vacío si no hay ninguno.

approved_emails

string[]

Direcciones de correo electrónico verificadas obtenidas de las sesiones aprobadas de este usuario, p. ej., ["john@example.com"].

approved_phones

string[]

Números de teléfono verificados obtenidos de las sesiones aprobadas de este usuario, p. ej., ["+14155551234"].

features

object

Estado agregado por función de todas las sesiones de este usuario. Claves posibles: ID_VERIFICATION, NFC, LIVENESS, FACE_MATCH, POA, QUESTIONNAIRE, EMAIL_VERIFICATION, PHONE, AML, IP_ANALYSIS, AGE_ESTIMATION, DATABASE_VALIDATION. Valores posibles: Approved, Declined, In Review, Not Finished, Resub Requested.

features_list

object[]

Los mismos datos que features, como un array ordenado de objetos {feature, status}.

Show child attributes

last_session_at

string<date-time> | null

Marca de tiempo de la sesión más reciente

first_session_at

string<date-time> | null

Marca de tiempo de la primera sesión

last_activity_at

string<date-time> | null

Marca de tiempo de la actividad más reciente de este usuario (sesión, transacción, cambio de estado, edición de datos, etc.).

​Descripción general

​Cuándo usarlo

​Notas

​Aplicación de medidas

​Permisos

​Relacionado

Autorizaciones

Parámetros de ruta

Cuerpo

Respuesta

Descripción general

Cuándo usarlo

Notas

Aplicación de medidas

Permisos

Relacionado