> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.
# API para actualizar estado del usuario: bloquear o marcar
> Bloquea, marca o activa un usuario en Didit. El estado se aplica a futuras sesiones KYC y al análisis de transacciones. Pago por llamada.
Prompt para actualizar el estado de un usuario
Copiar el prompt al portapapeles
\
\`Goal: Flip ONLY the lifecycle status of a Didit User entity. Use the full PATCH /v3/users/{vendor_data}/ when you also need to touch other fields.
Endpoint: PATCH https://verification.didit.me/v3/users/{vendor_data}/update-status/
Auth header: x-api-key:
Content-Type: application/json
Path param:
\- vendor_data (string, REQUIRED) — free-form string, NOT a UUID. URL-encode.
Request body:
\- status (enum, REQUIRED) — "ACTIVE" | "FLAGGED" | "BLOCKED" (VendorUserStatusChoices, NOT the session enum).
\- reason (string, optional, max 1000): why the status changed. Recorded as the comment of the STATUS_CHANGED entry in the user's activity (comments[].comment), only when the status actually changes. Webhooks do not carry it.
Status semantics:
\- ACTIVE → normal. New sessions allowed for this vendor_data.
\- FLAGGED → still accepted, highlighted in Console for manual review; filterable with ?status=FLAGGED.
\- BLOCKED → terminal. Adds vendor_data to the system blocklist. Subsequent session creations for the same identifier are rejected with a blocklist hit. Flipping back to ACTIVE/FLAGGED removes the blocklist entry automatically.
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", "reason": "Chargeback fraud pattern confirmed"}'
Response 200: full updated UserDetailItem (same shape as GET /v3/users/{vendor_data}/). See /reference/data-models.
Side effects:
\- Toggles the system blocklist entry when entering/leaving BLOCKED.
\- Writes one STATUS_CHANGED entry to the user's comments activity log (actor = API key identity), with reason as its comment.
\- Idempotent — re-sending the same status is a no-op (no extra audit row, no extra blocklist toggle).
Failure modes:
\- 400 — validation:
\{ "status": "This field is required." }
\{ "status": "Invalid status. Valid options are: ACTIVE, FLAGGED, BLOCKED" }
\{ "reason": ["Ensure this field has no more than 1000 characters."] }
\- 401 — missing/invalid x-api-key. { "detail": "Authentication credentials were not provided." }
\- 403 — the API key is revoked or is not valid for this application. { "detail": "You do not have permission to perform this action." }
\- 403: a scoped API key without users write. { "detail": "This API key has no write access to people." }
\- 404 — vendor_data not found (or deleted). { "detail": "Not found." }
\- 429 — rate-limited.
For end-to-end Didit integration, paste in the full prompt at /integration/integration-prompt.`
\
Pegar en
## Descripción generalCambia el estado de una [entidad de usuario](https://docs.didit.me/es/entities/users/overview.md) entre `ACTIVE`, `FLAGGED` y `BLOCKED`. Consulta el [ciclo de vida de las entidades](https://docs.didit.me/es/entities/lifecycle.md) 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 |## PermisosEl secreto principal y las [claves de API](https://docs.didit.me/es/console/api-keys.md) 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](https://docs.didit.me/es/console/roles-permissions.md) 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- [Ciclo de vida de las entidades](https://docs.didit.me/es/entities/lifecycle.md)
- [Lista de bloqueo de usuarios](https://docs.didit.me/es/entities/users/blocklist.md)
- [Webhooks de entidades](https://docs.didit.me/es/entities/webhooks.md)
## OpenAPI
````yaml es/openapi-25.json PATCH /v3/users/{vendor_data}/update-status/
openapi: 3.0.0
info:
version: 3.0.0
title: Didit Verification API
description: API de verificación de identidad. Autentícate con el encabezado x-api-key.
servers:
- url: https://verification.didit.me
security: []
tags: []
paths:
/v3/users/{vendor_data}/update-status/:
patch:
tags:
- Users
summary: Actualizar el estado del usuario
description: >-
Cambia solo el `status` del ciclo de vida de un usuario: `ACTIVE`,
`FLAGGED` o `BLOCKED` (no los estados de sesión). `BLOCKED` añade el
`vendor_data` a la lista de bloqueo del sistema; salir de `BLOCKED`
elimina esa entrada. Cada cambio se registra como una actividad
`STATUS_CHANGED` en el usuario, con el `reason` opcional como su
`comment`. Enviar el estado actual no cambia nada y no registra ningún
`reason`. El webhook `user.status.updated` no incluye `reason`.
operationId: update_user_status
parameters:
- name: vendor_data
in: path
required: true
schema:
type: string
description: Tu identificador único del usuario.
requestBody:
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/EntityStatusUpdateRequest'
- type: object
properties:
reason:
type: string
nullable: true
maxLength: 1000
description: >-
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.
examples:
Activate:
summary: Reactivar al usuario
value:
status: ACTIVE
Flag:
summary: Marcar al usuario para revisión
value:
status: FLAGGED
Block:
summary: >-
Bloquear el usuario (lo añade a la lista de bloqueo del
sistema)
value:
status: BLOCKED
Block with reason:
summary: Bloquear el usuario y registrar el motivo
value:
status: BLOCKED
reason: Chargeback fraud pattern confirmed
responses:
'200':
description: >-
Estado del usuario actualizado. Se devuelve el registro completo del
usuario.
content:
application/json:
schema:
$ref: '#/components/schemas/UserDetailItem'
examples:
Blocked:
value:
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:///...
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'
'400':
description: >-
`status` ausente o no válido, o un `reason` de más de 1000
caracteres.
content:
application/json:
examples:
Missing status:
value:
status:
- This field is required.
Bad status:
value:
status:
- >-
Invalid status. Valid options are: ACTIVE, FLAGGED,
BLOCKED
Reason too long:
value:
reason:
- Ensure this field has no more than 1000 characters.
'401':
description: >-
No se proporcionaron credenciales. El middleware de autenticación
rechaza las solicitudes a rutas `/v3/users/*` sin un encabezado
`x-api-key` (o un token `Authorization: Bearer`) antes de que
lleguen a la API.
content:
application/json:
examples:
Missing credentials:
value:
detail: >-
You must be authenticated with a valid access token to
access this endpoint.
'403':
description: >-
La clave no puede actualizar usuarios de esta aplicación. Si falta
la clave, se devuelve `403`; si la clave es incorrecta, está
revocada o ha expirado, se devuelve `401`.
content:
application/json:
examples:
Forbidden:
value:
detail: You do not have permission to perform this action.
'404':
description: >-
No existe ningún usuario (no eliminado) con el `vendor_data`
proporcionado para esta aplicación.
content:
application/json:
examples:
Not found:
value:
detail: Not found.
'429':
description: >-
Límite de solicitudes superado; espera y reintenta cuando haya
pasado el intervalo indicado en `Retry-After`.
content:
application/json:
examples:
Rate limited:
value:
detail: Request was throttled. Expected available in 30 seconds.
security:
- ApiKeyAuth: []
x-codeSamples:
- lang: curl
label: curl
source: >-
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"}'
- lang: python
label: Python
source: |-
from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.users.update_status(
"user-123",
status="ACTIVE",
)
print(result)
- lang: javascript
label: Node.js
source: |-
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);
- lang: go
label: Go
source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Users.UpdateStatus(ctx, \"user-123\", didit.UsersUpdateStatusParams{\n\tStatus: \"ACTIVE\",\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
- lang: java
label: Java
source: >-
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);
- lang: php
label: PHP
source: |-
users->updateStatus('user-123', [
'status' => 'ACTIVE',
]);
print_r($result->toArray());
- lang: ruby
label: Ruby
source: |-
require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.users.update_status(
"user-123",
status: "ACTIVE"
)
puts result.to_h
- lang: csharp
label: .NET
source: >-
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));
components:
schemas:
EntityStatusUpdateRequest:
type: object
required:
- status
properties:
status:
type: string
enum:
- ACTIVE
- FLAGGED
- BLOCKED
description: >-
Nuevo estado del ciclo de vida. `BLOCKED` también añade el
`vendor_data` a la lista de bloqueo del sistema.
UserDetailItem:
type: object
description: >-
Detalle completo del usuario. Amplía UserListItem con metadatos,
comentarios y updated_at.
allOf:
- $ref: '#/components/schemas/UserListItem'
- type: object
properties:
metadata:
type: object
description: >-
JSON de metadatos personalizados que adjuntaste a este usuario.
Valor predeterminado: `{}`.
tags:
type: array
description: >-
Asignaciones de etiquetas. NOTA: en las respuestas de detalle,
cada entrada es un objeto de *vínculo* de etiqueta (`{uuid, tag:
{...}, added_by_email, added_by_name, created_at}`), a
diferencia de la forma plana `{uuid, name, color}` que se usa en
las respuestas de listado.
items:
type: object
properties:
uuid:
type: string
format: uuid
description: >-
UUID de la asignación de etiqueta (no de la etiqueta en
sí).
tag:
type: object
properties:
uuid:
type: string
format: uuid
name:
type: string
color:
type: string
description:
type: string
nullable: true
source:
type: string
enum:
- didit
- custom
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
added_by_email:
type: string
nullable: true
added_by_name:
type: string
nullable: true
created_at:
type: string
format: date-time
comments:
type: array
items:
type: object
properties:
uuid:
type: string
format: uuid
comment_type:
type: string
enum:
- COMMENT
- STATUS_CHANGED
- METADATA_UPDATED
- TAG_ADDED
- TAG_REMOVED
- PROFILE_UPDATED
comment:
type: string
nullable: true
actor_email:
type: string
nullable: true
actor_name:
type: string
nullable: true
previous_status:
type: string
nullable: true
enum:
- ACTIVE
- FLAGGED
- BLOCKED
- null
new_status:
type: string
nullable: true
enum:
- ACTIVE
- FLAGGED
- BLOCKED
- null
previous_value:
type: object
nullable: true
description: >-
Valores anteriores de los campos en las entradas
PROFILE_UPDATED.
new_value:
type: object
nullable: true
description: Nuevos valores de campo para las entradas PROFILE_UPDATED.
changed_fields:
type: array
items:
type: string
description: >-
Nombres de los campos modificados por una entrada
PROFILE_UPDATED.
metadata:
type: object
nullable: true
mentioned_emails:
type: array
items:
type: string
created_at:
type: string
format: date-time
description: >-
Registro de actividad y comentarios de este usuario (cambios de
estado, ediciones del perfil, notas manuales).
updated_at:
type: string
format: date-time
UserListItem:
type: object
description: Un usuario verificado.
properties:
didit_internal_id:
type: string
format: uuid
description: UUID interno estable de Didit para este usuario.
vendor_data:
type: string
nullable: true
description: >-
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:
type: string
nullable: true
description: Nombre visible personalizado que has definido
full_name:
type: string
nullable: true
description: Nombre completo extraído de los documentos verificados
date_of_birth:
type: string
format: date
nullable: true
effective_name:
type: string
nullable: true
description: >-
Mejor nombre disponible: display_name si está definido; si no,
full_name
status:
type: string
enum:
- ACTIVE
- FLAGGED
- BLOCKED
description: >-
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`.
portrait_image_url:
type: string
nullable: true
description: >-
URL prefirmada de la foto de retrato del usuario (caduca al cabo de
unas horas)
session_count:
type: integer
description: Número total de sesiones de verificación de este usuario
approved_count:
type: integer
description: Número de sesiones aprobadas
declined_count:
type: integer
description: Número de sesiones rechazadas
in_review_count:
type: integer
description: Número de sesiones en revisión
issuing_states:
type: array
items:
type: string
description: >-
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:
type: array
items:
type: string
description: >-
Direcciones de correo electrónico verificadas obtenidas de las
sesiones aprobadas de este usuario, p. ej., `["john@example.com"]`.
approved_phones:
type: array
items:
type: string
description: >-
Números de teléfono verificados obtenidos de las sesiones aprobadas
de este usuario, p. ej., `["+14155551234"]`.
features:
type: object
description: >-
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:
type: array
items:
type: object
properties:
feature:
type: string
status:
type: string
description: >-
Los mismos datos que `features`, como un array ordenado de objetos
`{feature, status}`.
last_session_at:
type: string
format: date-time
nullable: true
description: Marca de tiempo de la sesión más reciente
first_session_at:
type: string
format: date-time
nullable: true
description: Marca de tiempo de la primera sesión
last_activity_at:
type: string
format: date-time
nullable: true
description: >-
Marca de tiempo de la actividad más reciente de este usuario
(sesión, transacción, cambio de estado, edición de datos, etc.).
tags:
type: array
items:
type: object
properties:
uuid:
type: string
format: uuid
name:
type: string
color:
type: string
description: Etiquetas asignadas a este usuario
created_at:
type: string
format: date-time
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: >-
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.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.