> ## 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 para actualizar usuario: entidad de proveedor

> Actualiza los campos editables de un usuario en Didit: nombre visible, metadatos y etiquetas. Los datos de identidad verificados no se pueden modificar.



Prompt para actualizar un usuario
        Copiar el prompt al portapapeles



      
      

\<pre>

\`Goal: Partial-update a Didit User entity by vendor_data.

Endpoint: PATCH https://verification.didit.me/v3/users/{vendor_data}/
Auth header: x-api-key: <DIDIT_API_KEY>
Content-Type: application/json

Path param:
\- vendor_data (string, REQUIRED) — free-form string, NOT a UUID. URL-encode.

Request body (PARTIAL — only included fields are touched; auto-derived counters and session history are left alone):
\- full_name (string, max 512, nullable)
\- display_name (string, nullable)
\- date_of_birth (string YYYY-MM-DD, nullable)
\- status (enum) — "ACTIVE" | "FLAGGED" | "BLOCKED" (VendorUserStatusChoices). Setting "BLOCKED" auto-adds vendor_data to the system blocklist; flipping away removes it.
\- metadata (object, nullable) — REPLACES existing metadata wholesale; merge client-side if you only want to add keys.
\- approved_emails (object<string, boolean>)
\- approved_phones (object<string, boolean>)
\- issuing_states (object<ISO3, int>)
\- 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 this update actually changes status. Webhooks do not carry it.

curl:
curl -X PATCH 'https://verification.didit.me/v3/users/user-abc-123/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"display_name": "Jane S.", "status": "FLAGGED", "reason": "Address does not match the billing country"}'

Response 200: full updated UserDetailItem (same shape as GET). See /reference/data-models.

Side effects:
\- Writes to the user's comments activity log (actor derived from the API key): a STATUS_CHANGED entry with reason when status changes, and a PROFILE_UPDATED entry when display_name, full_name, date_of_birth or metadata change.
\- last_activity_at bumped to now().
\- Concurrent updates: last-write-wins per field.
\- Re-sending an unchanged body is safe (no extra audit row).

Failure modes:
\- 400 — validation. Examples:
\{ "status": ["Invalid status. Valid options are: ACTIVE, FLAGGED, BLOCKED"] }
\{ "metadata": ["Metadata must be a JSON object."] }
date_of_birth must be YYYY-MM-DD.
\{ "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. { "detail": "Not found." }
\- 429 — rate-limited.

Notes:
\- vendor_data in the URL itself cannot be changed via this endpoint — create new + delete old to rekey.
\- For status-only flips, prefer the dedicated PATCH /v3/users/{vendor_data}/update-status/.
\- Overriding fields populated by a verified session is allowed but flagged in the audit log.

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

\</pre>



      
      

Pegar en

## Descripción generalActualiza los campos modificables de una [entidad User](https://docs.didit.me/es/entities/users/overview.md). Los campos que provienen de sesiones verificadas de verificación de usuarios (KYC) (`full_name`, `date_of_birth`, `portrait_image`, los contadores agregados y `features`) son de solo lectura.## Cuándo usarlo- **Actualizar tus propios metadatos**: mover a un usuario de un nivel a otro, cambiar etiquetas o registrar una nota interna.
- **Renombrar**: asignar un `display_name` más claro para las vistas internas de la consola.
- **Sobrescribir datos verificados** (con precaución): se permiten las sobrescrituras manuales, pero quedan registradas en el registro de auditoría.## Notas- El `vendor_data` de la URL no se puede cambiar con este endpoint. Si necesitas cambiar el identificador, crea un usuario nuevo y elimina el anterior.
- Emite un webhook `user.data.updated` con un array `changed_fields` para que los consumidores puedan sincronizarse de forma eficiente.
- Un cambio de `status` aquí funciona igual que [Actualizar el estado del usuario](https://docs.didit.me/es/management-api/users/update-status.md).
  Se registra en la actividad de la persona, con el `reason` opcional (hasta 1000 caracteres) como comentario, y `BLOCKED` añade el `vendor_data` a la lista de bloqueo del sistema.
  El webhook `user.status.updated` no incluye `reason`.
- Si aplicas PATCH a un campo que actualmente está gestionado por una sesión verificada, la sobrescritura se aceptará, pero se marcará en el [registro de auditoría](https://docs.didit.me/es/console/audit-logs.md).## PermisosEl secreto principal y las [claves de API](https://docs.didit.me/es/console/api-keys.md) con acceso completo siempre pueden invocar este endpoint.
Una clave con acceso personalizado necesita permiso de escritura en **Personas** (`users`).
Una clave limitada a algunos flujos o a sesiones aprobadas no puede acceder a este endpoint.Los [roles y permisos](https://docs.didit.me/es/console/roles-permissions.md) de la consola determinan lo que un miembro del equipo puede hacer en la consola.
No se evalúan en las solicitudes hechas con clave de API.## Relacionado- [Operaciones de usuarios](https://docs.didit.me/es/entities/users/operations.md)
- [Modelo de datos](https://docs.didit.me/es/entities/users/data-model.md)
- [Actualizar el estado](https://docs.didit.me/es/management-api/users/update-status.md)


## OpenAPI

````yaml es/openapi-25.json PATCH /v3/users/{vendor_data}/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: API de verificación de identidad. Autentícate con el encabezado x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/users/{vendor_data}/:
    patch:
      tags:
        - Users
      summary: Actualizar usuario
      description: >-
        Actualización parcial de un usuario: `display_name`, `full_name`,
        `date_of_birth`, `status`, `metadata`,
        `approved_emails`/`approved_phones`/`issuing_states`. `metadata` se
        reemplaza por completo. Cambiar `status` aquí funciona igual que
        [Actualizar el estado del
        usuario](#patch-/v3/users/-vendor_data-/update-status/): registra una
        actividad `STATUS_CHANGED` con el `reason` opcional, y `BLOCKED` añade
        el `vendor_data` a la lista de bloqueo del sistema (salir de `BLOCKED`
        elimina esa entrada). Los cambios en `display_name`, `full_name`,
        `date_of_birth` o `metadata` se registran como una actividad
        `PROFILE_UPDATED`.
      operationId: update_user
      parameters:
        - name: vendor_data
          in: path
          required: true
          schema:
            type: string
          description: >-
            Tu identificador único del usuario (cadena de texto libre, NO un
            UUID).
          example: user-abc-123
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                full_name:
                  type: string
                  nullable: true
                  maxLength: 512
                  description: Nombre completo del usuario
                display_name:
                  type: string
                  nullable: true
                  description: Nombre visible personalizado para este usuario
                date_of_birth:
                  type: string
                  format: date
                  nullable: true
                  description: Fecha de nacimiento en formato YYYY-MM-DD
                status:
                  type: string
                  enum:
                    - ACTIVE
                    - FLAGGED
                    - BLOCKED
                  description: >-
                    Estado del ciclo de vida del usuario. Cada cambio se
                    registra como una actividad `STATUS_CHANGED`, y `BLOCKED`
                    añade el `vendor_data` a la lista de bloqueo del sistema
                    (salir de `BLOCKED` elimina esa entrada).
                metadata:
                  type: object
                  nullable: true
                  description: >-
                    Objeto JSON arbitrario que adjuntas al usuario. **Reemplaza
                    por completo** los metadatos existentes al actualizar:
                    combínalos en el cliente si solo quieres añadir claves.
                approved_emails:
                  type: array
                  items:
                    type: string
                  description: >-
                    Direcciones de correo electrónico verificadas de este
                    usuario, p. ej., `["john@example.com"]`. Reemplaza por
                    completo la lista almacenada.
                approved_phones:
                  type: array
                  items:
                    type: string
                  description: >-
                    Números de teléfono verificados de este usuario. Reemplaza
                    por completo la lista almacenada.
                issuing_states:
                  type: array
                  items:
                    type: string
                  description: >-
                    Países emisores (ISO 3166-1 alfa-3), p. ej., `["USA"]`.
                    Reemplaza por completo la lista almacenada.
                reason:
                  type: string
                  nullable: true
                  maxLength: 1000
                  description: >-
                    Por qué cambió el estado. Se registra en la entrada de
                    cambio de estado de la actividad del usuario
                    (`comments[].comment` y **Activity** en Business Console),
                    solo cuando el estado cambia realmente. Los webhooks no lo
                    incluyen.
            examples:
              Rename:
                summary: Establecer nombre visible
                value:
                  display_name: Jane S.
              Override status:
                summary: Marcar al usuario para revisión
                value:
                  status: FLAGGED
              Add metadata:
                summary: Reemplazar el JSON de metadatos
                value:
                  metadata:
                    tier: premium
                    risk_level: low
              Fix extracted DOB:
                summary: Corregir campos de perfil extraídos
                value:
                  full_name: Jane Elizabeth Smith
                  date_of_birth: '1985-11-22'
              Flag with reason:
                summary: Marcar al usuario y registrar el motivo
                value:
                  status: FLAGGED
                  reason: Address does not match the billing country
      responses:
        '200':
          description: >-
            Usuario actualizado. Se devuelve el registro completo y actualizado
            del usuario (con la misma estructura que Get User).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserDetailItem'
              examples:
                Updated:
                  value:
                    didit_internal_id: f4e5e1f2-94a9-4f86-8c16-2b7d9b4db418
                    vendor_data: user-abc-123
                    display_name: Jane S.
                    full_name: Jane Elizabeth Smith
                    date_of_birth: '1985-11-22'
                    effective_name: Jane S.
                    status: FLAGGED
                    metadata:
                      tier: premium
                    portrait_image_url: https://<media-host>/...
                    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: []
                    created_at: '2025-06-01T08:00:00Z'
                    updated_at: '2025-06-15T10:30:00Z'
        '400':
          description: >-
            Cuerpo no válido: normalmente un `status` desconocido o una
            `date_of_birth` que no está en formato `YYYY-MM-DD`.
          content:
            application/json:
              examples:
                Bad status:
                  value:
                    status:
                      - '"INVALID" is not a valid choice.'
                Bad date_of_birth:
                  value:
                    date_of_birth:
                      - >-
                        Date has wrong format. Use one of these formats instead:
                        YYYY-MM-DD.
                Reason too long:
                  value:
                    reason:
                      - Ensure this field has no more than 1000 characters.
        '401':
          description: >-
            No se proporcionaron credenciales. El middleware de autenticación
            rechaza las solicitudes a rutas `/v3/users/*` sin un encabezado
            `x-api-key` (o un token `Authorization: Bearer`) antes de que
            lleguen a la 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 clave no puede actualizar usuarios de esta aplicación. Si falta
            la clave, se devuelve `403`; si la clave es incorrecta, está
            revocada o ha expirado, se devuelve `401`.
          content:
            application/json:
              examples:
                Forbidden:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: >-
            No existe ningún usuario con el `vendor_data` proporcionado para
            esta aplicación.
          content:
            application/json:
              examples:
                Not found:
                  value:
                    detail: Not found.
        '429':
          description: >-
            Límite de solicitudes superado; espera y reintenta cuando haya
            pasado el intervalo indicado en `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/'
            \
              -H 'x-api-key: YOUR_API_KEY' \
              -H 'Content-Type: application/json' \
              -d '{"display_name": "Jane S.", "status": "FLAGGED"}'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.users.update(
                "user-abc-123",
                display_name="Jane S.",
            )
            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.update("user-abc-123", {
              display_name: "Jane S.",
            });
            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Users.Update(ctx, \"user-abc-123\", didit.UsersUpdateParams{\n\tDisplayName: didit.String(\"Jane S.\"),\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.UsersUpdateParams;


            // Reads DIDIT_API_KEY.

            Didit client = new Didit();


            var result = client.users().update("user-abc-123",
            UsersUpdateParams.builder()
                    .displayName("Jane S.")
                    .build());
            System.out.println(result);
        - lang: php
          label: PHP
          source: |-
            <?php

            require 'vendor/autoload.php';

            use Didit\DiditClient;

            // Reads DIDIT_API_KEY.
            $didit = new DiditClient();

            $result = $didit->users->update('user-abc-123', [
                'display_name' => 'Jane S.',
            ]);
            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

            # Reads DIDIT_API_KEY.
            didit = Didit::Client.new

            result = didit.users.update(
              "user-abc-123",
              display_name: "Jane S."
            )
            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.UpdateAsync("user-abc-123", new
            UsersUpdateParams

            {
                DisplayName = "Jane S.",
            });

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    UserDetailItem:
      type: object
      description: >-
        Detalle completo del usuario. Amplía UserListItem con metadatos,
        comentarios y updated_at.
      allOf:
        - $ref: '#/components/schemas/UserListItem'
        - type: object
          properties:
            metadata:
              type: object
              description: >-
                JSON de metadatos personalizados que adjuntaste a este usuario.
                Valor predeterminado: `{}`.
            tags:
              type: array
              description: >-
                Asignaciones de etiquetas. NOTA: en las respuestas de detalle,
                cada entrada es un objeto de *vínculo* de etiqueta (`{uuid, tag:
                {...}, added_by_email, added_by_name, created_at}`), a
                diferencia de la forma plana `{uuid, name, color}` que se usa en
                las respuestas de listado.
              items:
                type: object
                properties:
                  uuid:
                    type: string
                    format: uuid
                    description: >-
                      UUID de la asignación de etiqueta (no de la etiqueta en
                      sí).
                  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: >-
                      Valores anteriores de los campos en las entradas
                      PROFILE_UPDATED.
                  new_value:
                    type: object
                    nullable: true
                    description: Nuevos valores de campo para las entradas PROFILE_UPDATED.
                  changed_fields:
                    type: array
                    items:
                      type: string
                    description: >-
                      Nombres de los campos modificados por una entrada
                      PROFILE_UPDATED.
                  metadata:
                    type: object
                    nullable: true
                  mentioned_emails:
                    type: array
                    items:
                      type: string
                  created_at:
                    type: string
                    format: date-time
              description: >-
                Registro de actividad y comentarios de este usuario (cambios de
                estado, ediciones del perfil, notas manuales).
            updated_at:
              type: string
              format: date-time
    UserListItem:
      type: object
      description: Un usuario verificado.
      properties:
        didit_internal_id:
          type: string
          format: uuid
          description: UUID interno estable de Didit para este usuario.
        vendor_data:
          type: string
          nullable: true
          description: >-
            Tu identificador único de este usuario (el que se envía al crear
            sesiones). Puede ser null si no se proporcionó ningún identificador
            propio.
        display_name:
          type: string
          nullable: true
          description: Nombre visible personalizado que has definido
        full_name:
          type: string
          nullable: true
          description: Nombre completo extraído de los documentos verificados
        date_of_birth:
          type: string
          format: date
          nullable: true
        effective_name:
          type: string
          nullable: true
          description: >-
            Mejor nombre disponible: display_name si está definido; si no,
            full_name
        status:
          type: string
          enum:
            - ACTIVE
            - FLAGGED
            - BLOCKED
          description: >-
            Estado del ciclo de vida del registro del usuario (NO es un estado
            de sesión). `ACTIVE` es el valor predeterminado, `FLAGGED` marca al
            usuario para atención manual y `BLOCKED` impide nuevas sesiones para
            este `vendor_data`.
        portrait_image_url:
          type: string
          nullable: true
          description: >-
            URL prefirmada de la foto de retrato del usuario (caduca al cabo de
            unas horas)
        session_count:
          type: integer
          description: Número total de sesiones de verificación de este usuario
        approved_count:
          type: integer
          description: Número de sesiones aprobadas
        declined_count:
          type: integer
          description: Número de sesiones rechazadas
        in_review_count:
          type: integer
          description: Número de sesiones en revisión
        issuing_states:
          type: array
          items:
            type: string
          description: >-
            Códigos ISO 3166-1 alpha-3 de los países emisores que figuran en los
            documentos de identidad aprobados de este usuario, p. ej., `["USA",
            "ESP"]`. Array vacío si no hay ninguno.
        approved_emails:
          type: array
          items:
            type: string
          description: >-
            Direcciones de correo electrónico verificadas obtenidas de las
            sesiones aprobadas de este usuario, p. ej., `["john@example.com"]`.
        approved_phones:
          type: array
          items:
            type: string
          description: >-
            Números de teléfono verificados obtenidos de las sesiones aprobadas
            de este usuario, p. ej., `["+14155551234"]`.
        features:
          type: object
          description: >-
            Estado agregado por función de todas las sesiones de este usuario.
            Claves posibles: `ID_VERIFICATION`, `NFC`, `LIVENESS`, `FACE_MATCH`,
            `POA`, `QUESTIONNAIRE`, `EMAIL_VERIFICATION`, `PHONE`, `AML`,
            `IP_ANALYSIS`, `AGE_ESTIMATION`, `DATABASE_VALIDATION`. Valores
            posibles: `Approved`, `Declined`, `In Review`, `Not Finished`,
            `Resub Requested`.
        features_list:
          type: array
          items:
            type: object
            properties:
              feature:
                type: string
              status:
                type: string
          description: >-
            Los mismos datos que `features`, como un array ordenado de objetos
            `{feature, status}`.
        last_session_at:
          type: string
          format: date-time
          nullable: true
          description: Marca de tiempo de la sesión más reciente
        first_session_at:
          type: string
          format: date-time
          nullable: true
          description: Marca de tiempo de la primera sesión
        last_activity_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            Marca de tiempo de la actividad más reciente de este usuario
            (sesión, transacción, cambio de estado, edición de datos, etc.).
        tags:
          type: array
          items:
            type: object
            properties:
              uuid:
                type: string
                format: uuid
              name:
                type: string
              color:
                type: string
          description: Etiquetas asignadas a este usuario
        created_at:
          type: string
          format: date-time
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        La clave de API de tu aplicación, que encontrarás en Developers -> API
        keys en la Business Console. La clave principal tiene acceso completo.
        Una clave con nombre puede tener un alcance limitado: ninguno, lectura o
        escritura por recurso, limitada a algunos flujos o a sesiones aprobadas,
        a una lista de direcciones IP y a una fecha de caducidad. 401 significa
        que la clave es incorrecta, se revocó o expiró; 403 significa que no se
        envió ninguna clave, que la clave no tiene acceso a este recurso o
        acción, o que la solicitud provino de una dirección fuera de su lista de
        IP; 404 en una ruta de sesión significa que la sesión está fuera de los
        flujos o estados de la clave. Una clave sin acceso a contenido
        multimedia recibe las URL de imágenes, videos y PDF como null, y una
        clave sin permiso de escritura en sesiones recibe los enlaces y tokens
        de sesión como null. Consulta https://docs.didit.me/console/api-keys.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.