Passer au contenu principal
PATCH
curl

Vue d’ensemble

Fait passer une entité Utilisateur d’un statut à un autre parmi ACTIVE, FLAGGED et BLOCKED. Consultez le cycle de vie des entités 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

Autorisations

Le secret principal et les clés API à 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 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

Autorisations

x-api-key
string
header
requis

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.

Paramètres de chemin

vendor_data
string
requis

Votre identifiant unique pour l'utilisateur.

Corps

application/json
status
enum<string>
requis

Nouveau statut de cycle de vie. BLOCKED ajoute également le vendor_data à la liste de blocage du système.

Options disponibles:
ACTIVE,
FLAGGED,
BLOCKED
reason
string | null

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.

Maximum string length: 1000

Réponse

Statut de l'utilisateur mis à jour. Enregistrement utilisateur complet renvoyé.

Détails complets de l'utilisateur. Étend UserListItem avec les métadonnées, les commentaires et updated_at.

didit_internal_id
string<uuid>

UUID interne stable de Didit pour cet utilisateur.

vendor_data
string | null

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
string | null

Nom d'affichage personnalisé défini par vous

full_name
string | null

Nom complet extrait des documents vérifiés

date_of_birth
string<date> | null
effective_name
string | null

Meilleur nom disponible : display_name s'il est défini, sinon full_name

status
enum<string>

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.

Options disponibles:
ACTIVE,
FLAGGED,
BLOCKED
portrait_image_url
string | null

URL pré-signée de la photo de portrait de l'utilisateur (expire après quelques heures)

session_count
integer

Nombre total de sessions de vérification pour cet utilisateur

approved_count
integer

Nombre de sessions approuvées

declined_count
integer

Nombre de sessions refusées

in_review_count
integer

Nombre de sessions en cours d'examen

issuing_states
string[]

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
string[]

Adresses e-mail vérifiées collectées à partir des sessions approuvées de cet utilisateur, par ex. ["john@example.com"].

approved_phones
string[]

Numéros de téléphone vérifiés collectés à partir des sessions approuvées de cet utilisateur, par ex. ["+14155551234"].

features
object

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
object[]

Mêmes données que features, sous la forme d'un tableau ordonné d'objets {feature, status}.

last_session_at
string<date-time> | null

Horodatage de la session la plus récente

first_session_at
string<date-time> | null

Horodatage de la première session

last_activity_at
string<date-time> | null

Horodatage de l'activité la plus récente sur cet utilisateur (session, transaction, changement de statut, modification des données, etc.).

tags
object[]

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.

created_at
string<date-time>
metadata
object

JSON de métadonnées personnalisées que vous avez associé à cet utilisateur. La valeur par défaut est {}.

comments
object[]

Journal d'activité et commentaires pour cet utilisateur (changements de statut, modifications de profil, notes manuelles).

updated_at
string<date-time>
Dernière modification le 7 novembre 2026