> ## 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 crear usuario: entidad de usuario del proveedor

> Crea entidades User en Didit antes de las sesiones KYC. Impórtalos en bloque desde bases externas o regístralos para monitorizar transacciones.



Prompt para crear un usuario
        Copiar el prompt al portapapeles



      
      

\<pre>

\`Goal: Pre-create a Didit User entity by vendor_data before any verification session runs, and optionally email the person a verification link in the same call.

Endpoint: POST https://verification.didit.me/v3/users/create/
Auth header: x-api-key: <DIDIT_API_KEY>
Content-Type: application/json

Request body fields:
\- vendor_data (string, REQUIRED) — your unique identifier for this user. Free-form string, NOT a UUID. Must be unique among non-deleted users in the app. Normalised lowercase + whitespace trim, so "USER-1" and "user-1" collide. Max 2000 bytes (UTF-8 encoded); longer values return a 400.
\- full_name (string, max 512, optional)
\- display_name (string, optional) — friendly label for the Console (takes precedence over full_name for UI).
\- date_of_birth (string YYYY-MM-DD, optional)
\- status (enum, optional) — "ACTIVE" | "FLAGGED" | "BLOCKED" (VendorUserStatusChoices). Defaults to "ACTIVE".
\- metadata (object, optional) — arbitrary JSON you attach to the user.
\- approved_emails (object<string, boolean>, optional) — e.g. {"john@example.com": true}.
\- approved_phones (object<string, boolean>, optional).
\- issuing_states (object<ISO3, int>, optional) — e.g. {"USA": 1}.

Contact fields (all optional):
\- first_name, last_name (string, max 255 each): joined with a space into full_name when you don't send full_name.
\- email (string, email): stored in metadata.contact.email.
\- phone_number (string, max 32): stored in metadata.contact.phone_number.
\- country (string): ISO 3166 code, alpha-2 or alpha-3 ("ES" or "ESP"), stored uppercased in metadata.address.country.

Verification link (optional):
\- send_verification_link (boolean, default false): when true, Didit also creates a verification session for the person on workflow_id and emails them the link at email.
\- workflow_id (UUID): REQUIRED with send_verification_link. The workflow must verify a person: a Business Verification (KYB) workflow is refused.
\- language (string, max 10): language of the verification email, a supported language code. English when omitted.
\- The person and the session are created together or not at all. The session runs the same checks as POST /v3/session/ (blocklist, credits).

curl:
curl -X POST 'https://verification.didit.me/v3/users/create/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"vendor_data": "user-abc-123", "full_name": "John Doe"}'

curl with a verification link:
curl -X POST 'https://verification.didit.me/v3/users/create/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"vendor_data": "user-abc-789", "first_name": "Julia", "last_name": "Martin", "email": "julia.martin@example.com", "send_verification_link": true, "workflow_id": "YOUR_WORKFLOW_ID"}'

Response 201: full UserDetailItem (same shape as GET /v3/users/{vendor_data}/) plus verification_link. Includes didit_internal_id (UUID), session_count, approved_count=0, metadata, comments=[], created_at, updated_at. See /reference/data-models.
\- verification_link is always present: null without a link, otherwise { session_id, session_number, status, url, workflow_id, email }. url is the link Didit emailed.

Failure modes:
\- 400: nothing is written. Most errors are keyed by field. Common cases:
\{ "vendor_data": ["A user with this vendor_data already exists."] }  // conflict, NOT idempotent. Use PATCH /v3/users/{vendor_data}/ to update.
\{ "vendor_data": ["This field is required."] }
\{ "vendor_data": ["Ensure this field has no more than 2000 characters."] }  // oversized vendor_data, rejected before it reaches storage
\{ "metadata": ["Metadata must be a JSON object."] }
\{ "country": ["Use an ISO 3166 country code, like ES or ESP."] }
\{ "email": ["metadata.contact must be a JSON object to store this value."] }  // same on phone_number; metadata.address on country
\{ "email": ["An email address is required to send a verification link."] }
\{ "workflow_id": ["Pick the workflow to send a verification link for."] }
\{ "workflow_id": ["Invalid workflow_id."] }
\{ "workflow_id": ["This workflow verifies a business. Pick a workflow that verifies a person to send them a verification link."] }
\{ "contact_details": { "email_lang": ["Invalid email language. Supported languages are ..."] } }  // unsupported language
\{ "vendor_data": "This user or business has been blocked and cannot create new verification sessions." }
\{ "detail": "You don't have enough credits to perform this request. Please top up at https://business.didit.me" }
\- 401: missing or 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 key without users write. { "detail": "This API key has no write access to people." }
\- 403: send_verification_link with a scoped key that lacks sessions write. Nothing is written. { "detail": "This API key has no write access to sessions." }
\- 429: rate-limited.

Upsert pattern (this endpoint is NOT idempotent):
GET /v3/users/{vendor_data}/  → on 404, POST /v3/users/create/; on 200, PATCH /v3/users/{vendor_data}/.

Notes:
\- Verified-session-derived identity fields such as full_name and date_of_birth seeded here can be overwritten by the first approved User Verification (KYC) session.
\- If you are migrating from another provider and already have a trusted face image, create the User first, read didit_internal_id from this response, then call POST /v3/organization/{organization_id}/application/{application_id}/vendor-users/by-id/{didit_internal_id}/faces/upload/.
\- The create itself sends no webhook. Later changes to the user send user.data.updated or user.status.updated. With send_verification_link, the new session updates the user (session_count) in the same call, which sends user.data.updated.
\- API key access: a scoped key needs users write; with send_verification_link it also needs sessions write. Full-access keys can always call it.

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

\</pre>



      
      

Pegar en

## Descripción generalCrea de forma explícita una [entidad de usuario](https://docs.didit.me/es/entities/users/overview.md) antes de que se ejecute cualquier sesión.
La entidad devuelta queda en estado `ACTIVE`, salvo que indiques otra cosa.
De forma opcional, la misma llamada envía a la persona un enlace de verificación por correo electrónico (consulta [Enviar un enlace de verificación](#enviar-un-enlace-de-verificación)).## Cuándo usarlo- **Precargar metadatos** (nivel, origen del registro, etiquetas internas) antes de que el cliente se verifique.
- **Migrar desde otro proveedor**: recrea en Didit tu lista de usuarios existente para que el historial y las analíticas partan de una base conocida.
- **Importar rostros de perfiles de confianza**: crea primero el User y luego llama a [Subir rostro de usuario](https://docs.didit.me/es/management-api/users/upload-face.md) con el `didit_internal_id` devuelto.
- **Casos de uso solo de transacciones**: registra un User con `vendor_data` para poder enviar transacciones sin ejecutar nunca una sesión de Verificación de usuarios (KYC).
- **Invitar a alguien a verificarse**: crea a la persona y envíale un enlace de verificación por correo electrónico en una sola llamada.## Datos de contactoPuedes enviar los datos de contacto de la persona junto con los campos del perfil.
`first_name` y `last_name` se unen con un espacio en `full_name` cuando no envías `full_name`.
`email` y `phone_number` se guardan en `metadata.contact`, y `country` en `metadata.address`.
`country` admite un código ISO 3166, alfa-2 o alfa-3 (`ES` o `ESP`), y se guarda en mayúsculas.Si el `metadata` que envías ya tiene un valor `contact` o `address` que no es un objeto JSON, Didit no lo sobrescribe: la solicitud responde con `400` en el campo de contacto correspondiente.## Enviar un enlace de verificaciónEstablece `send_verification_link` en `true` para invitar a la persona a verificarse en la misma solicitud.
Didit crea una sesión de verificación para la persona en el flujo de verificación (workflow) indicado en `workflow_id` y le envía el enlace por correo electrónico a `email`.
Usa `language` para elegir el [idioma](https://docs.didit.me/es/integration/supported-languages.md) del correo; si lo omites, se envía en inglés.```bash theme={null}
curl -X POST https://verification.didit.me/v3/users/create/ \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "vendor_data": "user-abc-789",
    "first_name": "Julia",
    "last_name": "Martin",
    "email": "julia.martin@example.com",
    "send_verification_link": true,
    "workflow_id": "YOUR_WORKFLOW_ID",
    "language": "es"
  }'
```- `email` y `workflow_id` son obligatorios al solicitar un enlace, y el flujo debe verificar a una persona: un flujo de Verificación de empresas (KYB) devuelve `400`.
- La sesión pasa por las mismas comprobaciones que [Crear sesión](https://docs.didit.me/es/sessions-api/create-session.md).
  Un `vendor_data` en la lista de bloqueo o créditos insuficientes provocan una respuesta `400`.
- La persona y la sesión se crean juntas o no se crea ninguna.
  Cuando falla cualquier comprobación, no se guarda nada y no se envía ningún correo.
- La respuesta incluye `verification_link` con el `session_id`, `session_number`, `status`, `url` y `workflow_id` de la sesión, y el `email` al que se envió.
  Sin enlace, `verification_link` es `null`.## Notas- `vendor_data` es obligatorio y debe ser único por aplicación. Intentar crear un duplicado devuelve un error de conflicto: usa [`PATCH /v3/users/{vendor_data}/`](https://docs.didit.me/es/management-api/users/update) para actualizar un usuario existente.
- `vendor_data` tiene un límite estricto de 2000 bytes (codificado en UTF-8). Un valor que supere ese límite devuelve un error de validación 400 en lugar de aceptarse.
- Los campos que normalmente se derivan de sesiones verificadas (`full_name`, `date_of_birth`) pueden precargarse aquí, pero la primera sesión aprobada de Verificación de usuarios (KYC) puede **sobrescribirlos**.
- Este endpoint no acepta imágenes faciales. Para asociar un rostro importado de confianza, usa [`POST /v3/organization/{organization_id}/application/{application_id}/vendor-users/by-id/{didit_internal_id}/faces/upload/`](https://docs.didit.me/es/management-api/users/upload-face) después de que este endpoint devuelva `didit_internal_id`.
- La creación en sí no envía ningún webhook. Los cambios posteriores en el usuario envían `user.data.updated` o `user.status.updated`.
- Con `send_verification_link`, la nueva sesión actualiza el usuario en la misma llamada, lo que envía `user.data.updated`.## PermisosEl secreto principal y las [claves de API](https://docs.didit.me/es/console/api-keys.md) con acceso completo siempre pueden llamar a este endpoint.
Una clave con acceso personalizado necesita permiso de escritura en **Personas** (`users`).
Con `send_verification_link: true` también necesita permiso de escritura en **Sesiones**, porque la llamada crea una sesión y entrega su enlace.
Sin él, la llamada responde `403` con `This API key has no write access to sessions.` y no se escribe nada.
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 deciden qué puede hacer un miembro del equipo en la consola.
No se evalúan en las solicitudes con clave de API.## Relacionado- [Modelo de datos del usuario](https://docs.didit.me/es/entities/users/data-model.md)
- [Subir rostro de usuario](https://docs.didit.me/es/management-api/users/upload-face.md)
- [Vinculación de datos de proveedores](https://docs.didit.me/es/entities/vendor-data-linking.md)
- [Operaciones de usuarios](https://docs.didit.me/es/entities/users/operations.md)


## OpenAPI

````yaml es/openapi-25.json POST /v3/users/create/
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/create/:
    post:
      tags:
        - Users
      summary: Crear usuario
      description: >-
        Crea un [usuario](/entities/users) por `vendor_data`, antes de una
        sesión de verificación o sin ella. `vendor_data` debe ser único entre
        los usuarios de la aplicación (un duplicado devuelve `400`). No es
        idempotente.


        **Datos de contacto:** `email` y `phone_number` se guardan en
        `metadata.contact`, y `country` en `metadata.address`. Si envías
        `first_name` o `last_name` sin `full_name`, Didit los une en
        `full_name`.


        **Enlace de verificación:** con `send_verification_link: true`, Didit
        también crea una sesión de verificación para la persona en `workflow_id`
        y le envía el enlace por correo electrónico a `email`. La sesión ejecuta
        las mismas comprobaciones que [Crear
        sesión](/es/sessions-api/create-session), como la lista de bloqueo y tu
        saldo de créditos. La persona y la sesión se crean juntas o no se crea
        ninguna: si alguna comprobación falla, no se escribe nada y no se envía
        ningún correo. El campo `verification_link` de la respuesta describe la
        sesión y es `null` cuando no solicitas un enlace.


        **Acceso con clave de API:** una clave de API con alcance limitado
        necesita permiso de escritura en `users`. Con `send_verification_link:
        true` también necesita permiso de escritura en `sessions`; de lo
        contrario, la llamada responde `403` antes de escribir nada. Las claves
        con acceso completo no se ven afectadas. Consulta [Claves de
        API](/es/console/api-keys).
      operationId: create_user
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - vendor_data
              properties:
                vendor_data:
                  type: string
                  description: >-
                    Tu identificador único de este usuario (cadena de texto
                    libre, NO un UUID). Debe ser único entre los usuarios de la
                    aplicación; se compara exactamente tal como se envía.
                full_name:
                  type: string
                  nullable: true
                  maxLength: 512
                  description: Nombre legal completo del usuario.
                display_name:
                  type: string
                  nullable: true
                  description: >-
                    Nombre visible descriptivo que se muestra en la consola
                    (tiene prioridad sobre `full_name` en la interfaz).
                  maxLength: 255
                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
                  default: ACTIVE
                  description: >-
                    Estado inicial del ciclo de vida. El valor predeterminado es
                    `ACTIVE`.
                metadata:
                  type: object
                  nullable: true
                  description: >-
                    Objeto JSON arbitrario que adjuntas al usuario. Por defecto
                    es `{}`.
                approved_emails:
                  type: array
                  items:
                    type: string
                  description: >-
                    Direcciones de correo electrónico de confianza previa para
                    este usuario, por ejemplo `["john@example.com"]`.
                approved_phones:
                  type: array
                  items:
                    type: string
                  description: >-
                    Números de teléfono de confianza previa para este usuario,
                    por ejemplo `["+14155551234"]`.
                issuing_states:
                  type: array
                  items:
                    type: string
                  description: >-
                    Países emisores registrados previamente (ISO 3166-1
                    alpha-3), por ejemplo `["USA"]`.
                first_name:
                  type: string
                  maxLength: 255
                  description: >-
                    Nombre de pila. Cuando no se envía `full_name`, Didit une
                    `first_name` y `last_name` con un espacio en `full_name`. No
                    se devuelve como campo independiente.
                last_name:
                  type: string
                  maxLength: 255
                  description: >-
                    Apellido. Se une con `first_name` para formar `full_name`
                    cuando no se envía `full_name`. No se devuelve como campo
                    independiente.
                email:
                  type: string
                  format: email
                  description: >-
                    Correo electrónico de contacto, que se guarda en
                    `metadata.contact.email` (reemplaza cualquier `email` que
                    envíes dentro de `metadata.contact`). Es obligatorio cuando
                    `send_verification_link` es `true`: el enlace se envía a
                    esta dirección. Si `metadata.contact` no es un objeto JSON,
                    la llamada responde `400` en este campo.
                phone_number:
                  type: string
                  maxLength: 32
                  description: >-
                    Número de teléfono de contacto, que se guarda en
                    `metadata.contact.phone_number`. Si `metadata.contact` no es
                    un objeto JSON, la llamada responde `400` en este campo.
                country:
                  type: string
                  maxLength: 3
                  description: >-
                    País como código ISO 3166, alfa-2 o alfa-3 (`ES` o `ESP`).
                    Se guarda en mayúsculas en `metadata.address.country`. Si
                    `metadata.address` no es un objeto JSON, la llamada responde
                    `400` en este campo.
                send_verification_link:
                  type: boolean
                  default: false
                  description: >-
                    Si es `true`, Didit crea una sesión de verificación para la
                    persona en `workflow_id` y le envía el enlace por correo
                    electrónico a `email`. Requiere `email` y `workflow_id`. Una
                    clave de API con alcance limitado también necesita permiso
                    de escritura en `sessions`.
                workflow_id:
                  type: string
                  format: uuid
                  description: >-
                    El flujo de la sesión de verificación. Obligatorio cuando
                    `send_verification_link` es `true`. Debe verificar a una
                    persona: se rechaza un flujo de Verificación de empresas
                    (KYB). En caso contrario, se ignora.
                language:
                  type: string
                  maxLength: 10
                  description: >-
                    Idioma del correo electrónico de verificación, como código
                    de [idioma admitido](/es/integration/supported-languages).
                    Inglés si se omite. Se ignora cuando
                    `send_verification_link` no es `true`.
            examples:
              Basic:
                summary: Crear con información básica
                value:
                  vendor_data: user-abc-123
                  full_name: John Doe
              Full:
                summary: Todos los campos
                value:
                  vendor_data: user-abc-456
                  full_name: Jane Smith
                  display_name: Jane S.
                  date_of_birth: '1990-05-15'
                  status: ACTIVE
                  metadata:
                    tier: premium
                    source: api
                  approved_emails:
                    - jane@example.com
              Contact details:
                summary: Nombre, correo electrónico, teléfono y país
                value:
                  vendor_data: user-abc-789
                  first_name: Julia
                  last_name: Martin
                  email: julia.martin@example.com
                  phone_number: '+34600000000'
                  country: ES
              With verification link:
                summary: >-
                  Crear la persona y enviarle por correo un enlace de
                  verificación
                value:
                  vendor_data: user-abc-789
                  first_name: Julia
                  last_name: Martin
                  email: julia.martin@example.com
                  send_verification_link: true
                  workflow_id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                  language: es
      responses:
        '201':
          description: >-
            Usuario creado. El registro completo del usuario (con la misma
            estructura que Get User), más `verification_link`: la sesión de
            verificación que Didit envió por correo electrónico cuando
            `send_verification_link` era `true`; en caso contrario, `null`.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/UserDetailItem'
                  - type: object
                    required:
                      - verification_link
                    properties:
                      verification_link:
                        type: object
                        nullable: true
                        description: >-
                          La sesión de verificación que Didit creó y envió por
                          correo electrónico a la persona. Siempre presente:
                          `null` cuando `send_verification_link` no era `true`.
                        required:
                          - session_id
                          - session_number
                          - status
                          - url
                          - workflow_id
                          - email
                        properties:
                          session_id:
                            type: string
                            format: uuid
                            description: ID de la sesión de verificación.
                          session_number:
                            type: integer
                            description: >-
                              Número secuencial de la sesión dentro de tu
                              aplicación.
                          status:
                            type: string
                            description: >-
                              Estado de la sesión; `Not Started` para una sesión
                              recién creada.
                          url:
                            type: string
                            format: uri
                            description: >-
                              El enlace de verificación que Didit envió por
                              correo electrónico a la persona.
                          workflow_id:
                            type: string
                            format: uuid
                            nullable: true
                            description: El flujo que ejecuta la sesión.
                          email:
                            type: string
                            format: email
                            description: La dirección a la que se envió el enlace.
              examples:
                Created:
                  value:
                    didit_internal_id: f4e5e1f2-94a9-4f86-8c16-2b7d9b4db418
                    vendor_data: user-abc-123
                    display_name: null
                    full_name: John Doe
                    date_of_birth: null
                    effective_name: John Doe
                    status: ACTIVE
                    metadata: {}
                    portrait_image_url: null
                    session_count: 0
                    approved_count: 0
                    declined_count: 0
                    in_review_count: 0
                    issuing_states: []
                    approved_emails: []
                    approved_phones: []
                    features: {}
                    features_list: []
                    last_session_at: null
                    last_activity_at: '2025-06-15T10:30:00Z'
                    first_session_at: null
                    tags: []
                    comments: []
                    created_at: '2025-06-15T10:30:00Z'
                    updated_at: '2025-06-15T10:30:00Z'
                    verification_link: null
                Created with verification link:
                  value:
                    didit_internal_id: 9b2f6c1e-3d4a-4e5f-8a7b-1c2d3e4f5a6b
                    vendor_data: user-abc-789
                    display_name: null
                    full_name: Julia Martin
                    date_of_birth: null
                    effective_name: Julia Martin
                    status: ACTIVE
                    metadata:
                      contact:
                        email: julia.martin@example.com
                    portrait_image_url: null
                    session_count: 1
                    approved_count: 0
                    declined_count: 0
                    in_review_count: 0
                    issuing_states: []
                    approved_emails: []
                    approved_phones: []
                    features: {}
                    features_list: []
                    last_session_at: '2025-06-15T10:30:00Z'
                    last_activity_at: '2025-06-15T10:30:00Z'
                    first_session_at: '2025-06-15T10:30:00Z'
                    tags: []
                    comments: []
                    created_at: '2025-06-15T10:30:00Z'
                    updated_at: '2025-06-15T10:30:00Z'
                    verification_link:
                      session_id: 3fa85f64-5717-4562-b3fc-2c963f66afa7
                      session_number: 43762
                      status: Not Started
                      url: https://verify.didit.me/en/session/3FaJ9wLqX2Mz
                      workflow_id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                      email: julia.martin@example.com
        '400':
          description: >-
            Cuerpo no válido, con los errores agrupados por campo: normalmente
            un `vendor_data` duplicado, un campo obligatorio ausente o un valor
            mal formado. Con `send_verification_link: true`, también un `email`
            o `workflow_id` ausente, un flujo desconocido o de Verificación de
            empresas (KYB), un `language` no admitido (con la clave
            `contact_details.email_lang`), un `vendor_data` en la lista de
            bloqueo o créditos insuficientes para iniciar la sesión. No se
            escribe nada.
          content:
            application/json:
              examples:
                Duplicate:
                  value:
                    vendor_data:
                      - A user with this vendor_data already exists.
                Missing vendor_data:
                  value:
                    vendor_data:
                      - This field is required.
                Bad metadata:
                  value:
                    metadata:
                      - Metadata must be a JSON object.
                Bad status:
                  value:
                    status:
                      - >-
                        Invalid status. Valid options are: ACTIVE, FLAGGED,
                        BLOCKED
                Bad country:
                  value:
                    country:
                      - Use an ISO 3166 country code, like ES or ESP.
                Contact not an object:
                  value:
                    email:
                      - >-
                        metadata.contact must be a JSON object to store this
                        value.
                Address not an object:
                  value:
                    country:
                      - >-
                        metadata.address must be a JSON object to store this
                        value.
                Link without email or workflow:
                  value:
                    email:
                      - >-
                        An email address is required to send a verification
                        link.
                    workflow_id:
                      - Pick the workflow to send a verification link for.
                Unknown workflow:
                  value:
                    workflow_id:
                      - Invalid workflow_id.
                Business workflow:
                  value:
                    workflow_id:
                      - >-
                        This workflow verifies a business. Pick a workflow that
                        verifies a person to send them a verification link.
                Blocklisted vendor_data:
                  value:
                    vendor_data: >-
                      This user or business has been blocked and cannot create
                      new verification sessions.
                Insufficient credits:
                  value:
                    detail: >-
                      You don't have enough credits to perform this request.
                      Please top up at https://business.didit.me
        '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: >-
            Clave de API no válida o revocada, o la clave no puede crear
            usuarios para esta aplicación. Una clave de API con alcance limitado
            necesita permiso de escritura en `users`, y también de escritura en
            `sessions` cuando `send_verification_link` es `true`; no se escribe
            nada. 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.
                No sessions write:
                  summary: >-
                    Una clave con alcance limitado solicita un enlace de
                    verificación sin permiso de escritura en sessions
                  value:
                    detail: This API key has no write access to sessions.
        '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 POST 'https://verification.didit.me/v3/users/create/' \
              -H 'x-api-key: YOUR_API_KEY' \
              -H 'Content-Type: application/json' \
              -d '{"vendor_data": "user-abc-123", "full_name": "John Doe"}'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.users.create(
                vendor_data="user-abc-123",
                full_name="John Doe",
            )
            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.create({
              vendor_data: "user-abc-123",
              full_name: "John Doe",
            });
            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Users.Create(ctx, didit.UsersCreateParams{\n\tVendorData: \"user-abc-123\",\n\tFullName:   didit.String(\"John Doe\"),\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.UsersCreateParams;

            // Reads DIDIT_API_KEY.
            Didit client = new Didit();

            var result = client.users().create(UsersCreateParams.builder()
                    .vendorData("user-abc-123")
                    .fullName("John Doe")
                    .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->create([
                'vendor_data' => 'user-abc-123',
                'full_name' => 'John Doe',
            ]);
            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

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

            result = didit.users.create(
              vendor_data: "user-abc-123",
              full_name: "John Doe"
            )
            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.CreateAsync(new UsersCreateParams
            {
                VendorData = "user-abc-123",
                FullName = "John Doe",
            });
            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.