> ## 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 Get User : entité utilisateur fournisseur > Récupérez un utilisateur fournisseur Didit par vendor_data : identité, statut, compteurs KYC et carte des fonctionnalités. KYC persistant, facturé à l'appel. Prompt de récupération d'un utilisateur Copier le prompt dans le presse-papiers \

\`Goal: Fetch a single Didit User entity by your own vendor_data.

Endpoint: GET https://verification.didit.me/v3/users/{vendor_data}/
Auth header: x-api-key: 

Path param:
\- vendor_data (string, REQUIRED) — your unique identifier. Free-form string, NOT a UUID. Matching is case-insensitive after Didit normalisation. URL-encode it.

curl:
curl -X GET 'https://verification.didit.me/v3/users/user-abc-123/' \
-H 'x-api-key: YOUR_API_KEY'

Response 200 (UserDetailItem) — extends the list shape with metadata, comments (activity log), and updated_at. Key fields:
\- didit_internal_id (UUID — Didit's stable internal identifier)
\- vendor_data (string)
\- display_name, full_name, date_of_birth, effective_name, portrait_image_url
\- status: "ACTIVE" | "FLAGGED" | "BLOCKED" (VendorUserStatusChoices)
\- session_count, approved_count, declined_count, in_review_count (aggregate counters)
\- features (map of feature -> latest status)
\- approved_emails, approved_phones, issuing_states
\- metadata (arbitrary JSON you attached)
\- comments (chronological activity log: status changes, manual notes, system events)
\- created_at, updated_at
See /reference/data-models for the full schema.

Notes:
\- Aggregate counters update in real time as sessions reach terminal status.
\- For bulk lookups, prefer paging GET /v3/users/ and indexing locally on vendor_data instead of fanning out one call per identifier.

Failure modes (envelope {"detail": "..."}):
\- 401 — missing or invalid x-api-key.
\- 403 — the API key is revoked or is not valid for this application.
\- 404 — no user with that vendor_data in this application.
\- 429 — rate-limited.

For end-to-end Didit integration, paste in the full prompt at /integration/integration-prompt.`

\
Coller dans ## Vue d'ensembleRenvoie une seule [entité User](https://docs.didit.me/fr/entities/users/overview.md) identifiée par `vendor_data`. Les réponses incluent `didit_internal_id`, l'identifiant interne stable de Didit.## Quand l'utiliser- **Recherche** de l'état de vérification actuel d'un utilisateur : le dictionnaire `features` vous donne le statut le plus récent de chaque fonctionnalité dans un seul objet. - **Vues détaillées** dans votre propre interface : récupérez le profil à la demande, avant l'affichage. - **Notation des risques** : combinez les compteurs de sessions et `features` pour noter chaque utilisateur de votre côté.## Remarques- `vendor_data` dans l'URL est sensible à la casse. - Renvoie `404` si aucun utilisateur avec ce `vendor_data` n'existe dans l'application. - Les compteurs agrégés (`session_count`, `approved_count`, `declined_count`, `in_review_count`) sont mis à jour en temps réel à mesure que les sessions se terminent. - Consultez le [modèle de données utilisateur](https://docs.didit.me/fr/entities/users/data-model.md) pour connaître chaque champ.## AutorisationsToute clé API active de l'application peut appeler cet endpoint. Les clés API Didit sont **limitées à l'application, et non à un rôle** : les [rôles et autorisations](https://docs.didit.me/fr/console/roles-permissions.md) de la Console (`read:users` et les autres) déterminent ce qu'une *personne* peut faire dans la Console, et ne sont pas évalués pour le trafic de l'API de gestion. Pour contrôler qui peut appeler cet endpoint, contrôlez qui peut lire la clé API de l'application.## Ressources associées- [Vue d'ensemble des utilisateurs](https://docs.didit.me/fr/entities/users/overview.md) - [Modèle de données](https://docs.didit.me/fr/entities/users/data-model.md) - [Lister les utilisateurs](https://docs.didit.me/fr/management-api/users/list.md) ## OpenAPI ````yaml fr/openapi-25.json GET /v3/users/{vendor_data}/ 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}/: get: tags: - Users summary: Obtenir l'utilisateur description: >- Récupère un [utilisateur](/entities/users) par `vendor_data` (correspondance exacte). Ajoute `metadata`, `comments` et `updated_at` à la vue sous forme de liste, et bascule `tags` vers la structure détaillée des liens de tags. operationId: get_user parameters: - name: vendor_data in: path required: true schema: type: string description: >- Votre identifiant unique pour l'utilisateur — chaîne libre (PAS un UUID). Il s'agit de la même valeur que vous avez transmise en tant que `vendor_data` lors de la création de la session ayant introduit cet utilisateur pour la première fois, mise en correspondance exactement telle qu'envoyée. example: user-abc-123 responses: '200': description: >- Détails complets de l'utilisateur incluant les métadonnées, le journal des commentaires/d'activité et les données agrégées de session. content: application/json: schema: $ref: '#/components/schemas/UserDetailItem' examples: Active user: 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: ACTIVE 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: null actor_email: analyst@acme.com actor_name: Jane Analyst previous_status: FLAGGED new_status: ACTIVE previous_value: null new_value: null changed_fields: [] metadata: null mentioned_emails: [] created_at: '2025-06-01T10:30:00Z' created_at: '2025-06-01T08:00:00Z' updated_at: '2025-06-15T10:30:00Z' '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: >- Clé API non valide ou révoquée, ou la clé ne peut pas lire les utilisateurs de 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 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 GET 'https://verification.didit.me/v3/users/user-abc-123/' \ -H 'x-api-key: YOUR_API_KEY' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() result = client.users.retrieve( "user-abc-123", ) 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.retrieve("user-abc-123"); console.log(result); - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Users.Retrieve(ctx, \"user-abc-123\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" - lang: java label: Java source: |- import me.didit.Didit; // Reads DIDIT_API_KEY. Didit client = new Didit(); var result = client.users().retrieve("user-abc-123"); System.out.println(result); - lang: php label: PHP source: |- users->retrieve('user-abc-123'); print_r($result->toArray()); - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new result = didit.users.retrieve("user-abc-123") 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.RetrieveAsync("user-abc-123"); Console.WriteLine(JsonSerializer.Serialize(result)); components: schemas: 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.