> ## 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.
# Mise à jour du statut utilisateur : bloquer ou signaler
> Bloquez, signalez ou activez un utilisateur Didit. Le statut s'applique aux futures sessions KYC et aux transactions. Facturé à l'appel.
Prompt de mise à jour du statut utilisateur
Copier le prompt dans le presse-papiers
\
\`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.`
\
Coller dans
## Vue d'ensembleFait passer une [entité Utilisateur](https://docs.didit.me/fr/entities/users/overview.md) d'un statut à un autre parmi `ACTIVE`, `FLAGGED` et `BLOCKED`. Consultez le [cycle de vie des entités](https://docs.didit.me/fr/entities/lifecycle.md) pour la machine à états complète.## Quand l'utiliser- **Bloquer un utilisateur** après avoir confirmé une fraude ou une violation de la conformité.
- **Signaler un utilisateur** en attente d'un examen manuel, sans le bloquer définitivement.
- **Débloquer** un utilisateur après une régularisation réussie.
- **Propager des signaux externes** : par exemple, lorsque votre propre moteur de fraude attribue à un utilisateur un score supérieur à un seuil, faites-le passer à `FLAGGED` via cet endpoint.## Remarques- Valeurs valides : `ACTIVE`, `FLAGGED`, `BLOCKED`. Les valeurs non valides renvoient 400.
- Vous pouvez transmettre un `reason` facultatif (jusqu'à 1000 caractères) pour enregistrer la raison du changement de statut.
Didit le conserve comme commentaire de l'entrée de changement de statut dans l'activité de la personne : `comments[].comment` sur l'utilisateur, et **Activité** dans la Business Console.
Il n'est enregistré que lorsque le statut change réellement.
- Les utilisateurs `BLOCKED` voient toutes leurs nouvelles sessions et toutes leurs nouvelles transactions refusées automatiquement.
- Émet un webhook `user.status.updated` contenant `previous_status` et `status`.
Le webhook ne contient pas `reason`.## Application| Statut | Effet sur les nouvelles sessions | Effet sur les nouvelles transactions |
| - | - | - |
| `ACTIVE` | Parcours normal | Parcours normal |
| `FLAGGED` | Autorisées, mais orientées vers `IN_REVIEW` | Autorisées ; peuvent être escaladées automatiquement selon les règles |
| `BLOCKED` | Refusées automatiquement | Refusées automatiquement |## AutorisationsLe secret principal et les [clés API](https://docs.didit.me/fr/console/api-keys.md) à accès complet peuvent toujours appeler cet endpoint.
Une clé à accès personnalisé a besoin de l'autorisation d'écriture sur **Personnes** (`users`).
Une clé limitée à certains workflows ou à certaines sessions approuvées ne peut pas appeler cet endpoint.Les [rôles et autorisations](https://docs.didit.me/fr/console/roles-permissions.md) de la Console déterminent ce qu'un membre de l'équipe peut faire dans la Console.
Ils ne sont pas évalués pour les requêtes effectuées avec une clé API.## Pages associées- [Cycle de vie des entités](https://docs.didit.me/fr/entities/lifecycle.md)
- [Liste de blocage des utilisateurs](https://docs.didit.me/fr/entities/users/blocklist.md)
- [Webhooks des entités](https://docs.didit.me/fr/entities/webhooks.md)
## OpenAPI
````yaml fr/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 vérification d'identité. Authentifiez-vous avec l'en-tête x-api-key.
servers:
- url: https://verification.didit.me
security: []
tags: []
paths:
/v3/users/{vendor_data}/update-status/:
patch:
tags:
- Users
summary: Mettre à jour le statut de l'utilisateur
description: "Basculer uniquement le `status` de cycle de vie d'un utilisateur\_: `ACTIVE`, `FLAGGED` ou `BLOCKED` (pas les statuts de session). `BLOCKED` ajoute le `vendor_data` à la liste de blocage du système\_; quitter l'état `BLOCKED` supprime cette entrée. Chaque modification est enregistrée sous forme d'activité `STATUS_CHANGED` sur l'utilisateur, avec le `reason` facultatif comme `comment`. Envoyer le statut actuel ne change rien et n'enregistre aucun `reason`. Le webhook `user.status.updated` ne transmet pas `reason`."
operationId: update_user_status
parameters:
- name: vendor_data
in: path
required: true
schema:
type: string
description: Votre identifiant unique pour l'utilisateur.
requestBody:
required: true
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/EntityStatusUpdateRequest'
- type: object
properties:
reason:
type: string
nullable: true
maxLength: 1000
description: >-
Raison pour laquelle le statut a changé. Enregistrée sur
l'entrée de changement de statut de l'activité de
l'utilisateur (`comments[].comment`, et **Activité**
dans la Business Console), uniquement lorsque le statut
change réellement. Les webhooks ne la transmettent pas.
examples:
Activate:
summary: Réactiver l'utilisateur
value:
status: ACTIVE
Flag:
summary: Signaler l'utilisateur pour examen
value:
status: FLAGGED
Block:
summary: >-
Bloquer l'utilisateur (ajoute à la liste de blocage du
système)
value:
status: BLOCKED
Block with reason:
summary: Bloquer l'utilisateur et consigner le motif
value:
status: BLOCKED
reason: Chargeback fraud pattern confirmed
responses:
'200':
description: >-
Statut de l'utilisateur mis à jour. Enregistrement utilisateur
complet renvoyé.
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` manquant ou invalide, ou un `reason` de plus de 1000
caractères.
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: >-
Aucun identifiant fourni. Les requêtes vers les chemins
`/v3/users/*` sans en-tête `x-api-key` (ou token `Authorization:
Bearer`) sont rejetées par le middleware d'authentification avant
d'atteindre 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 clé ne peut pas mettre à jour les utilisateurs pour cette
application. Une clé manquante renvoie `403` ; une clé erronée,
révoquée ou expirée renvoie `401`.
content:
application/json:
examples:
Forbidden:
value:
detail: You do not have permission to perform this action.
'404':
description: >-
Aucun utilisateur (non supprimé) avec le `vendor_data` fourni
n'existe pour cette application.
content:
application/json:
examples:
Not found:
value:
detail: Not found.
'429':
description: >-
Limite de débit dépassée ; réduisez la cadence et réessayez après
l'intervalle indiqué dans `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: >-
Nouveau statut de cycle de vie. `BLOCKED` ajoute également le
`vendor_data` à la liste de blocage du système.
UserDetailItem:
type: object
description: >-
Détails complets de l'utilisateur. Étend UserListItem avec les
métadonnées, les commentaires et updated_at.
allOf:
- $ref: '#/components/schemas/UserListItem'
- type: object
properties:
metadata:
type: object
description: >-
JSON de métadonnées personnalisées que vous avez associé à cet
utilisateur. La valeur par défaut est `{}`.
tags:
type: array
description: >-
Attributions de tags. REMARQUE : sur les réponses détaillées,
chaque entrée est un objet de *liaison* de tag (`{uuid, tag:
{...}, added_by_email, added_by_name, created_at}`),
contrairement au format plat `{uuid, name, color}` utilisé sur
les réponses de liste.
items:
type: object
properties:
uuid:
type: string
format: uuid
description: UUID de l'attribution du tag (et non le tag lui-même).
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: >-
Valeurs précédentes des champs pour les entrées
PROFILE_UPDATED.
new_value:
type: object
nullable: true
description: >-
Nouvelles valeurs de champ pour les entrées
PROFILE_UPDATED.
changed_fields:
type: array
items:
type: string
description: Noms des champs modifiés par une entrée PROFILE_UPDATED.
metadata:
type: object
nullable: true
mentioned_emails:
type: array
items:
type: string
created_at:
type: string
format: date-time
description: >-
Journal d'activité et commentaires pour cet utilisateur
(changements de statut, modifications de profil, notes
manuelles).
updated_at:
type: string
format: date-time
UserListItem:
type: object
description: Un utilisateur vérifié.
properties:
didit_internal_id:
type: string
format: uuid
description: UUID interne stable de Didit pour cet utilisateur.
vendor_data:
type: string
nullable: true
description: >-
Votre identifiant unique pour cet utilisateur (transmis lors de la
création des sessions). Peut être nul si aucun identifiant
fournisseur n'a été fourni.
display_name:
type: string
nullable: true
description: Nom d'affichage personnalisé défini par vous
full_name:
type: string
nullable: true
description: Nom complet extrait des documents vérifiés
date_of_birth:
type: string
format: date
nullable: true
effective_name:
type: string
nullable: true
description: >-
Meilleur nom disponible : display_name s'il est défini, sinon
full_name
status:
type: string
enum:
- ACTIVE
- FLAGGED
- BLOCKED
description: >-
Statut de cycle de vie de l'enregistrement utilisateur (PAS un
statut de session). `ACTIVE` est la valeur par défaut, `FLAGGED`
signale l'utilisateur pour un examen manuel, `BLOCKED` empêche de
nouvelles sessions pour ce `vendor_data`.
portrait_image_url:
type: string
nullable: true
description: >-
URL pré-signée de la photo de portrait de l'utilisateur (expire
après quelques heures)
session_count:
type: integer
description: Nombre total de sessions de vérification pour cet utilisateur
approved_count:
type: integer
description: Nombre de sessions approuvées
declined_count:
type: integer
description: Nombre de sessions refusées
in_review_count:
type: integer
description: Nombre de sessions en cours d'examen
issuing_states:
type: array
items:
type: string
description: >-
Codes ISO 3166-1 alpha-3 des pays de délivrance observés sur les
documents d'identité approuvés de cet utilisateur, par ex. `["USA",
"ESP"]`. Tableau vide s'il n'y en a aucun.
approved_emails:
type: array
items:
type: string
description: >-
Adresses e-mail vérifiées collectées à partir des sessions
approuvées de cet utilisateur, par ex. `["john@example.com"]`.
approved_phones:
type: array
items:
type: string
description: >-
Numéros de téléphone vérifiés collectés à partir des sessions
approuvées de cet utilisateur, par ex. `["+14155551234"]`.
features:
type: object
description: "Statut agrégé par fonctionnalité sur l'ensemble des sessions de cet utilisateur. Clés possibles\_: `ID_VERIFICATION`, `NFC`, `LIVENESS`, `FACE_MATCH`, `POA`, `QUESTIONNAIRE`, `EMAIL_VERIFICATION`, `PHONE`, `AML`, `IP_ANALYSIS`, `AGE_ESTIMATION`, `DATABASE_VALIDATION`. Valeurs possibles\_: `Approved`, `Declined`, `In Review`, `Not Finished`, `Resub Requested`."
features_list:
type: array
items:
type: object
properties:
feature:
type: string
status:
type: string
description: >-
Mêmes données que `features`, sous la forme d'un tableau ordonné
d'objets `{feature, status}`.
last_session_at:
type: string
format: date-time
nullable: true
description: Horodatage de la session la plus récente
first_session_at:
type: string
format: date-time
nullable: true
description: Horodatage de la première session
last_activity_at:
type: string
format: date-time
nullable: true
description: >-
Horodatage de l'activité la plus récente sur cet utilisateur
(session, transaction, changement de statut, modification des
données, etc.).
tags:
type: array
items:
type: object
properties:
uuid:
type: string
format: uuid
name:
type: string
color:
type: string
description: Tags attribués à cet utilisateur
created_at:
type: string
format: date-time
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: >-
La clé API de votre application, issue de Développeurs -> Clés API dans
la Business Console. La clé principale dispose d'un accès complet. Une
clé nommée peut être restreinte : aucun, lecture ou écriture par
ressource, limitée à certains workflows ou aux sessions approuvées, à
une liste d'adresses IP et à une date d'expiration. 401 signifie que la
clé est incorrecte, révoquée ou expirée ; 403 signifie qu'aucune clé n'a
été envoyée, que la clé n'a pas accès à cette ressource ou action, ou
que la requête provient d'une adresse hors de sa liste d'IP ; 404 sur
une route de session signifie que la session est hors des workflows ou
des statuts de la clé. Une clé sans accès aux médias reçoit les URL
d'images, de vidéos et de PDF à null, et une clé sans accès en écriture
aux sessions reçoit les liens et tokens de session à null. Voir
https://docs.didit.me/console/api-keys.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.