Passer au contenu principal
PATCH
curl

Vue d’ensemble

Met à jour les champs modifiables d’une entité utilisateur. Les champs transmis depuis les sessions de Vérification des utilisateurs (KYC) vérifiées (full_name, date_of_birth, portrait_image, compteurs agrégés, features) sont en lecture seule.

Quand l’utiliser

  • Mettez à jour vos propres métadonnées : déplacez un utilisateur vers un autre niveau, modifiez les tags, enregistrez une note interne.
  • Renommer : définissez un meilleur display_name pour les vues de la console destinées à un usage interne.
  • Remplacer les données vérifiées (avec précaution) : les remplacements manuels sont autorisés, mais ils sont consignés dans le journal d’audit.

Remarques

  • Le vendor_data présent dans l’URL ne peut pas être modifié via cet endpoint. Si vous devez changer de clé, créez un nouvel utilisateur puis supprimez l’ancien.
  • Émet un webhook user.data.updated contenant un tableau changed_fields, afin que les consommateurs puissent synchroniser les données efficacement.
  • Un changement de status effectué ici fonctionne comme Mettre à jour le statut de l’utilisateur. Il est enregistré dans l’activité de la personne, avec le reason facultatif (jusqu’à 1000 caractères) comme commentaire, et BLOCKED ajoute le vendor_data à la liste de blocage du système. L’événement webhook user.status.updated ne contient pas reason.
  • Si vous envoyez un PATCH sur un champ actuellement géré par une session vérifiée, le remplacement sera accepté mais signalé dans le journal d’audit.

Autorisations

La clé secrète principale 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 Personnes (users). Une clé limitée à certains workflows ou à des sessions approuvées ne peut pas accéder à 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 envoyées avec une clé API.

Voir aussi

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 (chaîne libre, PAS un UUID).

Corps

application/json
full_name
string | null

Nom complet de l'utilisateur

Maximum string length: 512
display_name
string | null

Nom d'affichage personnalisé pour cet utilisateur

date_of_birth
string<date> | null

Date de naissance au format YYYY-MM-DD

status
enum<string>

Statut du cycle de vie de l'utilisateur. Une modification est enregistrée sous forme d'activité STATUS_CHANGED, et BLOCKED ajoute les vendor_data à la liste de blocage du système (quitter BLOCKED supprime cette entrée).

Options disponibles:
ACTIVE,
FLAGGED,
BLOCKED
metadata
object | null

Objet JSON arbitraire que vous associez à l'utilisateur. Remplace complètement les métadonnées existantes lors de la mise à jour — fusionnez côté client si vous souhaitez uniquement ajouter des clés.

approved_emails
string[]

Adresses e-mail vérifiées pour cet utilisateur, par ex. ["john@example.com"]. Remplace entièrement la liste enregistrée.

approved_phones
string[]

Numéros de téléphone vérifiés pour cet utilisateur. Remplace entièrement la liste enregistrée.

issuing_states
string[]

Pays de délivrance (ISO 3166-1 alpha-3), par ex. ["USA"]. Remplace intégralement la liste stockée.

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

Utilisateur mis à jour. L'enregistrement utilisateur mis à jour complet (même structure que Obtenir l'utilisateur) est 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