> ## 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 d'estat d'usuari: bloquejar o marcar
> Bloqueja, marca o activa un usuari de proveïdor a Didit. L'estat s'aplica a les sessions KYC futures i al cribratge de transaccions.
Indicació per actualitzar l'estat de l'usuari
Copia el prompt al porta-retalls
\
\`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.`
\
Enganxa a
## Visió generalCanvia una [entitat d'usuari](https://docs.didit.me/ca/entities/users/overview.md) entre `ACTIVE`, `FLAGGED` i `BLOCKED`. Consulta el [cicle de vida de les entitats](https://docs.didit.me/ca/entities/lifecycle.md) 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 |## PermisosEl secret principal i les [claus d'API](https://docs.didit.me/ca/console/api-keys.md) 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](https://docs.didit.me/ca/console/roles-permissions.md) 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- [Cicle de vida de les entitats](https://docs.didit.me/ca/entities/lifecycle.md)
- [Llista de bloqueig d'usuaris](https://docs.didit.me/ca/entities/users/blocklist.md)
- [Webhooks de les entitats](https://docs.didit.me/ca/entities/webhooks.md)
## OpenAPI
````yaml ca/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ó d'identitat. Autentica't amb la capçalera x-api-key.
servers:
- url: https://verification.didit.me
security: []
tags: []
paths:
/v3/users/{vendor_data}/update-status/:
patch:
tags:
- Users
summary: Actualitza l'estat de l'usuari
description: >-
Canvia només el `status` del cicle de vida d'un usuari: `ACTIVE`,
`FLAGGED` o `BLOCKED` (no els estats de sessió). `BLOCKED` afegeix el
`vendor_data` a la llista de bloqueig del sistema; sortir de `BLOCKED`
elimina aquesta entrada. Cada canvi es registra com una activitat
`STATUS_CHANGED` a l'usuari, amb el `reason` opcional com a `comment`.
Enviar l'estat actual no canvia res ni registra cap `reason`. El webhook
`user.status.updated` no inclou el `reason`.
operationId: update_user_status
parameters:
- name: vendor_data
in: path
required: true
schema:
type: string
description: El teu identificador únic per a l'usuari.
requestBody:
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/EntityStatusUpdateRequest'
- type: object
properties:
reason:
type: string
nullable: true
maxLength: 1000
description: >-
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.
examples:
Activate:
summary: Reactivar l'usuari
value:
status: ACTIVE
Flag:
summary: Marca l'usuari per a revisió
value:
status: FLAGGED
Block:
summary: >-
Bloquejar l'usuari (s'afegeix a la llista de bloqueig del
sistema)
value:
status: BLOCKED
Block with reason:
summary: Bloquejar l'usuari i registrar-ne el motiu
value:
status: BLOCKED
reason: Chargeback fraud pattern confirmed
responses:
'200':
description: >-
Estat de l'usuari actualitzat. Es retorna el registre complet de
l'usuari.
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: >-
Falta l'`status` o no és vàlid, o el `reason` supera els 1000
caràcters.
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 s'han proporcionat credencials. Les sol·licituds a rutes
`/v3/users/*` sense una capçalera `x-api-key` (o token
`Authorization: Bearer`) són rebutjades pel middleware
d'autenticació abans d'arribar a l'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 clau no pot actualitzar usuaris per a aquesta aplicació. Una clau
absent retorna `403`; una clau incorrecta, revocada o caducada
retorna `401`.
content:
application/json:
examples:
Forbidden:
value:
detail: You do not have permission to perform this action.
'404':
description: >-
No existeix cap usuari (no eliminat) amb el `vendor_data`
proporcionat per a aquesta aplicació.
content:
application/json:
examples:
Not found:
value:
detail: Not found.
'429':
description: >-
S'ha superat el límit de freqüència; redueix el ritme de les
sol·licituds i reintenta-ho després de l'interval indicat a
`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: >-
Nou estat del cicle de vida. `BLOCKED` també afegeix el
`vendor_data` a la llista de bloqueig del sistema.
UserDetailItem:
type: object
description: >-
Detall complet de l'usuari. Amplia UserListItem amb metadades,
comentaris i updated_at.
allOf:
- $ref: '#/components/schemas/UserListItem'
- type: object
properties:
metadata:
type: object
description: >-
JSON de metadades personalitzades que has adjuntat a aquest
usuari. Per defecte és `{}`.
tags:
type: array
description: >-
Assignacions d'etiquetes. NOTA: a les respostes de detall cada
entrada és un objecte d'*enllaç* d'etiqueta (`{uuid, tag: {...},
added_by_email, added_by_name, created_at}`), a diferència de
l'estructura plana `{uuid, name, color}` utilitzada a les
respostes de llista.
items:
type: object
properties:
uuid:
type: string
format: uuid
description: UUID de l'assignació de l'etiqueta (no l'etiqueta en si).
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: Valors de camp anteriors per a entrades PROFILE_UPDATED.
new_value:
type: object
nullable: true
description: Nous valors de camp per a les entrades PROFILE_UPDATED.
changed_fields:
type: array
items:
type: string
description: >-
Noms dels camps modificats per una entrada
PROFILE_UPDATED.
metadata:
type: object
nullable: true
mentioned_emails:
type: array
items:
type: string
created_at:
type: string
format: date-time
description: >-
Registre d'activitat i comentaris per a aquest usuari (canvis
d'estat, edicions de perfil, notes manuals).
updated_at:
type: string
format: date-time
UserListItem:
type: object
description: Un usuari verificat.
properties:
didit_internal_id:
type: string
format: uuid
description: UUID intern estable de Didit per a aquest usuari.
vendor_data:
type: string
nullable: true
description: >-
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:
type: string
nullable: true
description: Nom visible personalitzat definit per tu
full_name:
type: string
nullable: true
description: Nom complet extret dels documents verificats
date_of_birth:
type: string
format: date
nullable: true
effective_name:
type: string
nullable: true
description: >-
Millor nom disponible: display_name si està definit, en cas contrari
full_name
status:
type: string
enum:
- ACTIVE
- FLAGGED
- BLOCKED
description: >-
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`.
portrait_image_url:
type: string
nullable: true
description: >-
URL presignada de la foto de retrat de l'usuari (caduca al cap
d'unes hores)
session_count:
type: integer
description: Nombre total de sessions de verificació per a aquest usuari
approved_count:
type: integer
description: Nombre de sessions aprovades
declined_count:
type: integer
description: Nombre de sessions rebutjades
in_review_count:
type: integer
description: Nombre de sessions en revisió
issuing_states:
type: array
items:
type: string
description: >-
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:
type: array
items:
type: string
description: >-
Adreces de correu electrònic verificades recollides de les sessions
aprovades d'aquest usuari, p. ex. `["john@example.com"]`.
approved_phones:
type: array
items:
type: string
description: >-
Números de telèfon verificats recollits de les sessions aprovades
d'aquest usuari, p. ex. `["+14155551234"]`.
features:
type: object
description: >-
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:
type: array
items:
type: object
properties:
feature:
type: string
status:
type: string
description: >-
Les mateixes dades que `features`, com una llista ordenada
d'objectes `{feature, status}`.
last_session_at:
type: string
format: date-time
nullable: true
description: Marca de temps de la sessió més recent
first_session_at:
type: string
format: date-time
nullable: true
description: Marca de temps de la primera sessió
last_activity_at:
type: string
format: date-time
nullable: true
description: >-
Marca de temps de l'activitat més recent d'aquest usuari (sessió,
transacció, canvi d'estat, edició de dades, etc.).
tags:
type: array
items:
type: object
properties:
uuid:
type: string
format: uuid
name:
type: string
color:
type: string
description: Etiquetes assignades a aquest usuari
created_at:
type: string
format: date-time
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: >-
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.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.