> ## 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.

# Crear usuari API: entitat d'usuari del proveïdor

> Crea entitats d'usuari a Didit abans de les sessions KYC, per importar usuaris en massa o per al monitoratge de transaccions.



Indicació per crear un usuari
        Copia el prompt al porta-retalls



      
      

\<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>



      
      

Enganxa a

## Visió generalCrea explícitament una [entitat d'usuari](https://docs.didit.me/ca/entities/users/overview.md) abans que s'executi cap sessió.
L'entitat retornada queda en estat `ACTIVE`, tret que especifiquis una altra cosa.
Opcionalment, la mateixa crida envia a la persona un enllaç de verificació (vegeu [Envia un enllaç de verificació](#envia-un-enllaç-de-verificació)).## Quan utilitzar-lo- **Precarregar metadades** (nivell, origen de l'alta, etiquetes internes) abans que el client es verifiqui.
- **Migrar des d'un altre proveïdor**: recrea el llistat d'usuaris actual a Didit perquè l'historial i les analítiques partin d'una base coneguda.
- **Importar rostres de perfil de confiança**: crea primer l'usuari i després crida [Puja el rostre de l'usuari](https://docs.didit.me/ca/management-api/users/upload-face.md) amb el `didit_internal_id` retornat.
- **Casos només de transaccions**: registra un usuari amb `vendor_data` perquè puguis enviar transaccions sense executar mai una sessió de Verificació d'usuaris (KYC).
- **Convidar algú a verificar-se**: crea la persona i envia-li un enllaç de verificació en una sola crida.## Dades de contactePots enviar les dades de contacte de la persona juntament amb els camps del perfil.
`first_name` i `last_name` s'uneixen amb un espai a `full_name` quan no envies `full_name`.
`email` i `phone_number` es guarden a `metadata.contact`, i `country` a `metadata.address`.
`country` accepta un codi ISO 3166, alfa-2 o alfa-3 (`ES` o `ESP`), i es guarda en majúscules.Si les `metadata` que envies ja tenen un valor `contact` o `address` que no és un objecte JSON, Didit no el sobreescriu: la crida respon amb `400` al camp de contacte que ho necessitava.## Envia un enllaç de verificacióEstableix `send_verification_link` a `true` per convidar la persona a verificar-se en la mateixa crida.
Didit crea una sessió de verificació per a la persona al flux de treball indicat a `workflow_id` i li envia l'enllaç a `email`.
Fes servir `language` per triar l'[idioma](https://docs.didit.me/ca/integration/supported-languages.md) del correu; si no l'especifiques, serà l'anglè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` i `workflow_id` són obligatoris amb un enllaç, i el flux de treball ha de verificar una persona: un flux de treball de Verificació d'empreses (KYB) respon amb `400`.
- La sessió passa per les mateixes comprovacions que [Crea una sessió](https://docs.didit.me/ca/sessions-api/create-session.md).
  Un `vendor_data` que figuri a la llista de bloqueig o massa pocs crèdits responen amb `400`.
- La persona i la sessió es creen juntes o no se'n crea cap.
  Si falla qualsevol comprovació, no s'escriu res i no s'envia cap correu.
- La resposta inclou `verification_link` amb el `session_id`, `session_number`, `status`, `url` i `workflow_id` de la sessió, i el `email` al qual s'ha enviat.
  Sense enllaç, `verification_link` és `null`.## Notes- `vendor_data` és obligatori i ha de ser únic per aplicació. Si intentes crear un duplicat, es retorna un error de conflicte; fes servir [`PATCH /v3/users/{vendor_data}/`](https://docs.didit.me/ca/management-api/users/update) per actualitzar un usuari existent.
- `vendor_data` té un límit estricte de 2000 bytes (codificat en UTF-8). Un valor que superi aquest límit retorna un error de validació 400 en lloc de ser acceptat.
- Els camps que normalment es deriven de sessions verificades (`full_name`, `date_of_birth`) es poden precarregar aquí, però la primera sessió de Verificació d'usuaris (KYC) aprovada els pot **sobreescriure**.
- Aquest endpoint no accepta imatges de rostres. Per adjuntar un rostre importat de confiança, fes servir [`POST /v3/organization/{organization_id}/application/{application_id}/vendor-users/by-id/{didit_internal_id}/faces/upload/`](https://docs.didit.me/ca/management-api/users/upload-face) després que aquest endpoint retorni `didit_internal_id`.
- La creació en si no envia cap webhook. Els canvis posteriors a l'usuari envien `user.data.updated` o `user.status.updated`.
- Amb `send_verification_link`, la nova sessió actualitza l'usuari en la mateixa crida, cosa que envia `user.data.updated`.## PermisosEl secret principal i les [claus d'API](https://docs.didit.me/ca/console/api-keys.md) amb accés complet sempre poden cridar aquest endpoint.
Una clau amb accés personalitzat necessita permís d'escriptura de **Persones** (`users`).
Amb `send_verification_link: true` també necessita permís d'escriptura de **Sessions**, perquè la crida crea una sessió i en lliura l'enllaç.
Sense aquest permís, la crida respon amb `403` i el missatge `This API key has no write access to sessions.`, i no s'escriu res.
Una clau limitada a alguns fluxos de treball o a sessions aprovades no pot accedir a aquest endpoint.Els [rols i permisos](https://docs.didit.me/ca/console/roles-permissions.md) de la Consola determinen què pot fer un membre de l'equip a la Consola.
No s'avaluen per a les sol·licituds amb clau d'API.## Relacionat- [Model de dades d'usuari](https://docs.didit.me/ca/entities/users/data-model.md)
- [Puja el rostre de l'usuari](https://docs.didit.me/ca/management-api/users/upload-face.md)
- [Vinculació de les dades del proveïdor](https://docs.didit.me/ca/entities/vendor-data-linking.md)
- [Operacions amb usuaris](https://docs.didit.me/ca/entities/users/operations.md)


## OpenAPI

````yaml ca/openapi-25.json POST /v3/users/create/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: API de verificació d'identitat. Autentica't amb la capçalera x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/users/create/:
    post:
      tags:
        - Users
      summary: Crea un usuari
      description: >-
        Crea un [usuari](/entities/users) mitjançant `vendor_data`, abans d'una
        sessió de verificació o sense fer-ne cap. `vendor_data` ha de ser únic
        entre els usuaris de l'aplicació (un duplicat retorna `400`). No és
        idempotent.


        **Dades de contacte:** `email` i `phone_number` s'emmagatzemen a
        `metadata.contact`, i `country` a `metadata.address`. Si envies
        `first_name` o `last_name` sense `full_name`, Didit els combina en
        `full_name`.


        **Enllaç de verificació:** amb `send_verification_link: true`, Didit
        també crea una sessió de verificació per a la persona en el flux de
        treball `workflow_id` i li envia l'enllaç per correu electrònic a
        `email`. La sessió executa les mateixes comprovacions que [Crear una
        sessió](/ca/sessions-api/create-session), com ara la llista de bloqueig
        i el teu saldo de crèdit. La persona i la sessió es creen juntes o no es
        creen: si falla qualsevol comprovació, no s'escriu res i no s'envia cap
        correu electrònic. El camp `verification_link` de la resposta descriu la
        sessió, i és `null` si no sol·licites cap enllaç.


        **Accés amb clau d'API:** una clau d'API amb abast necessita permisos
        d'escriptura a `users`. Amb `send_verification_link: true` també
        necessita permisos d'escriptura a `sessions`, o la crida respondrà amb
        `403` abans que s'escrigui res. Les claus amb accés complet no es veuen
        afectades. Consulta [Claus d'API](/ca/console/api-keys).
      operationId: create_user
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - vendor_data
              properties:
                vendor_data:
                  type: string
                  description: >-
                    El teu identificador únic per a aquest usuari (cadena de
                    text lliure, NO un UUID). Ha de ser únic entre els usuaris
                    de l'aplicació; coincideix exactament amb el valor enviat.
                full_name:
                  type: string
                  nullable: true
                  maxLength: 512
                  description: Nom legal complet de l'usuari.
                display_name:
                  type: string
                  nullable: true
                  description: >-
                    Nom descriptiu que es mostra a la consola (té prioritat
                    sobre `full_name` per a la visualització a la interfície
                    d'usuari).
                  maxLength: 255
                date_of_birth:
                  type: string
                  format: date
                  nullable: true
                  description: Data de naixement en format `YYYY-MM-DD`.
                status:
                  type: string
                  enum:
                    - ACTIVE
                    - FLAGGED
                    - BLOCKED
                  default: ACTIVE
                  description: Estat inicial del cicle de vida. Per defecte és `ACTIVE`.
                metadata:
                  type: object
                  nullable: true
                  description: >-
                    Objecte JSON arbitrari que adjuntes a l'usuari. Per defecte
                    és `{}`.
                approved_emails:
                  type: array
                  items:
                    type: string
                  description: >-
                    Adreces de correu electrònic de confiança prèvia per a
                    aquest usuari, p. ex. `["john@example.com"]`.
                approved_phones:
                  type: array
                  items:
                    type: string
                  description: >-
                    Números de telèfon de confiança prèvia per a aquest usuari,
                    p. ex. `["+14155551234"]`.
                issuing_states:
                  type: array
                  items:
                    type: string
                  description: >-
                    Països emissors preenregistrats (ISO 3166-1 alfa-3), p. ex.
                    `["USA"]`.
                first_name:
                  type: string
                  maxLength: 255
                  description: >-
                    Nom de pila. Quan no s'envia `full_name`, Didit uneix
                    `first_name` i `last_name` amb un espai per formar
                    `full_name`. No es retorna com a camp separat.
                last_name:
                  type: string
                  maxLength: 255
                  description: >-
                    Cognom. S'uneix amb `first_name` per formar `full_name` quan
                    no s'envia `full_name`. No es retorna com a camp separat.
                email:
                  type: string
                  format: email
                  description: >-
                    Correu electrònic de contacte, emmagatzemat a
                    `metadata.contact.email` (substitueix un `email` que enviïs
                    dins de `metadata.contact`). Obligatori quan
                    `send_verification_link` és `true`: l'enllaç s'envia a
                    aquesta adreça. Si `metadata.contact` no és un objecte JSON,
                    la crida respon `400` en aquest camp.
                phone_number:
                  type: string
                  maxLength: 32
                  description: >-
                    Número de telèfon de contacte, emmagatzemat a
                    `metadata.contact.phone_number`. Si `metadata.contact` no és
                    un objecte JSON, la crida respon `400` en aquest camp.
                country:
                  type: string
                  maxLength: 3
                  description: >-
                    País com a codi ISO 3166, alpha-2 o alpha-3 (`ES` o `ESP`).
                    S'emmagatzema en majúscules a `metadata.address.country`. Si
                    `metadata.address` no és un objecte JSON, la crida retorna
                    `400` per a aquest camp.
                send_verification_link:
                  type: boolean
                  default: false
                  description: >-
                    Quan és `true`, Didit crea una sessió de verificació per a
                    la persona a `workflow_id` i li envia l'enllaç per correu
                    electrònic a `email`. Requereix `email` i `workflow_id`. Una
                    clau d'API amb abast també necessita escriptura a
                    `sessions`.
                workflow_id:
                  type: string
                  format: uuid
                  description: >-
                    El flux de treball de la sessió de verificació. Obligatori
                    quan `send_verification_link` és `true`. Ha de verificar una
                    persona: es rebutja un flux de treball de Verificació
                    d'empreses (KYB). S'ignora en cas contrari.
                language:
                  type: string
                  maxLength: 10
                  description: >-
                    Idioma del correu electrònic de verificació, com a codi
                    d'[idioma admès](/ca/integration/supported-languages).
                    Anglès si s'omet. S'ignora quan `send_verification_link` no
                    és `true`.
            examples:
              Basic:
                summary: Crea amb informació bàsica
                value:
                  vendor_data: user-abc-123
                  full_name: John Doe
              Full:
                summary: Tots els camps
                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: Nom, correu electrònic, telèfon i 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: >-
                  Crea la persona i envia-li un enllaç de verificació per correu
                  electrònic
                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: >-
            Usuari creat. El registre complet de l'usuari (mateixa estructura
            que a Get User), més `verification_link`: la sessió de verificació
            que Didit ha enviat per correu electrònic quan
            `send_verification_link` era `true`; altrament, `null`.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/UserDetailItem'
                  - type: object
                    required:
                      - verification_link
                    properties:
                      verification_link:
                        type: object
                        nullable: true
                        description: >-
                          La sessió de verificació que Didit ha creat i ha
                          enviat per correu electrònic a la persona. Sempre
                          present: `null` quan `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 sessió de verificació.
                          session_number:
                            type: integer
                            description: >-
                              Número seqüencial de la sessió dins de la teva
                              aplicació.
                          status:
                            type: string
                            description: >-
                              Estat de la sessió, `Not Started` per a una sessió
                              acabada de crear.
                          url:
                            type: string
                            format: uri
                            description: >-
                              L'enllaç de verificació que Didit ha enviat per
                              correu electrònic a la persona.
                          workflow_id:
                            type: string
                            format: uuid
                            nullable: true
                            description: El flux de treball que executa la sessió.
                          email:
                            type: string
                            format: email
                            description: L'adreça a la qual s'ha enviat l'enllaç.
              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: >-
            Cos no vàlid, desglossat per camp: normalment un `vendor_data`
            duplicat, un camp obligatori que falta o un valor amb format
            incorrecte. Amb `send_verification_link: true`, també pot ser un
            `email` o `workflow_id` que falta, un flux de treball desconegut o
            de Verificació d'empreses (KYB), un `language` no admès (amb clau
            `contact_details.email_lang`), un `vendor_data` a la llista de
            bloqueig o crèdits insuficients per iniciar la sessió. No s'escriu
            res.
          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 s'han proporcionat credencials. Les sol·licituds a rutes
            `/v3/users/*` sense una capçalera `x-api-key` (o token
            `Authorization: Bearer`) són rebutjades pel middleware
            d'autenticació abans d'arribar a 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: >-
            Clau d'API no vàlida o revocada, o la clau no pot crear usuaris per
            a aquesta aplicació. Una clau d'API amb abast restringit necessita
            escriptura a `users`, i també escriptura a `sessions` quan
            `send_verification_link` és `true`; no s'escriu res. Una clau absent
            retorna `403`; una clau incorrecta, revocada o caducada retorna
            `401`.
          content:
            application/json:
              examples:
                Forbidden:
                  value:
                    detail: You do not have permission to perform this action.
                No sessions write:
                  summary: >-
                    La clau amb abast sol·licita un enllaç de verificació sense
                    tenir el permís d'escriptura de sessions
                  value:
                    detail: This API key has no write access to sessions.
        '429':
          description: >-
            S'ha superat el límit de freqüència; redueix el ritme de les
            sol·licituds i reintenta-ho després de l'interval indicat a
            `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: >-
        Detall complet de l'usuari. Amplia UserListItem amb metadades,
        comentaris i updated_at.
      allOf:
        - $ref: '#/components/schemas/UserListItem'
        - type: object
          properties:
            metadata:
              type: object
              description: >-
                JSON de metadades personalitzades que has adjuntat a aquest
                usuari. Per defecte és `{}`.
            tags:
              type: array
              description: >-
                Assignacions d'etiquetes. NOTA: a les respostes de detall cada
                entrada és un objecte d'*enllaç* d'etiqueta (`{uuid, tag: {...},
                added_by_email, added_by_name, created_at}`), a diferència de
                l'estructura plana `{uuid, name, color}` utilitzada a les
                respostes de llista.
              items:
                type: object
                properties:
                  uuid:
                    type: string
                    format: uuid
                    description: UUID de l'assignació de l'etiqueta (no l'etiqueta en si).
                  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: Valors de camp anteriors per a entrades PROFILE_UPDATED.
                  new_value:
                    type: object
                    nullable: true
                    description: Nous valors de camp per a les entrades PROFILE_UPDATED.
                  changed_fields:
                    type: array
                    items:
                      type: string
                    description: >-
                      Noms dels camps modificats per una entrada
                      PROFILE_UPDATED.
                  metadata:
                    type: object
                    nullable: true
                  mentioned_emails:
                    type: array
                    items:
                      type: string
                  created_at:
                    type: string
                    format: date-time
              description: >-
                Registre d'activitat i comentaris per a aquest usuari (canvis
                d'estat, edicions de perfil, notes manuals).
            updated_at:
              type: string
              format: date-time
    UserListItem:
      type: object
      description: Un usuari verificat.
      properties:
        didit_internal_id:
          type: string
          format: uuid
          description: UUID intern estable de Didit per a aquest usuari.
        vendor_data:
          type: string
          nullable: true
          description: >-
            El teu identificador únic per a aquest usuari (passat en crear
            sessions). Pot ser nul quan no s'ha proporcionat cap identificador
            de proveïdor.
        display_name:
          type: string
          nullable: true
          description: Nom visible personalitzat definit per tu
        full_name:
          type: string
          nullable: true
          description: Nom complet extret dels documents verificats
        date_of_birth:
          type: string
          format: date
          nullable: true
        effective_name:
          type: string
          nullable: true
          description: >-
            Millor nom disponible: display_name si està definit, en cas contrari
            full_name
        status:
          type: string
          enum:
            - ACTIVE
            - FLAGGED
            - BLOCKED
          description: >-
            Estat del cicle de vida del registre d'usuari (NO és un estat de la
            sessió). `ACTIVE` és el valor per defecte, `FLAGGED` marca l'usuari
            per a atenció manual, `BLOCKED` impedeix noves sessions per a aquest
            `vendor_data`.
        portrait_image_url:
          type: string
          nullable: true
          description: >-
            URL presignada de la foto de retrat de l'usuari (caduca al cap
            d'unes hores)
        session_count:
          type: integer
          description: Nombre total de sessions de verificació per a aquest usuari
        approved_count:
          type: integer
          description: Nombre de sessions aprovades
        declined_count:
          type: integer
          description: Nombre de sessions rebutjades
        in_review_count:
          type: integer
          description: Nombre de sessions en revisió
        issuing_states:
          type: array
          items:
            type: string
          description: >-
            Codis ISO 3166-1 alpha-3 dels països emissors que consten als
            documents d'identitat aprovats d'aquest usuari, p. ex. `["USA",
            "ESP"]`. Matriu buida si no n'hi ha cap.
        approved_emails:
          type: array
          items:
            type: string
          description: >-
            Adreces de correu electrònic verificades recollides de les sessions
            aprovades d'aquest usuari, p. ex. `["john@example.com"]`.
        approved_phones:
          type: array
          items:
            type: string
          description: >-
            Números de telèfon verificats recollits de les sessions aprovades
            d'aquest usuari, p. ex. `["+14155551234"]`.
        features:
          type: object
          description: >-
            Estat agregat per funcionalitat a totes les sessions d'aquest
            usuari. Claus possibles: `ID_VERIFICATION`, `NFC`, `LIVENESS`,
            `FACE_MATCH`, `POA`, `QUESTIONNAIRE`, `EMAIL_VERIFICATION`, `PHONE`,
            `AML`, `IP_ANALYSIS`, `AGE_ESTIMATION`, `DATABASE_VALIDATION`.
            Valors possibles: `Approved`, `Declined`, `In Review`, `Not
            Finished`, `Resub Requested`.
        features_list:
          type: array
          items:
            type: object
            properties:
              feature:
                type: string
              status:
                type: string
          description: >-
            Les mateixes dades que `features`, com una llista ordenada
            d'objectes `{feature, status}`.
        last_session_at:
          type: string
          format: date-time
          nullable: true
          description: Marca de temps de la sessió més recent
        first_session_at:
          type: string
          format: date-time
          nullable: true
          description: Marca de temps de la primera sessió
        last_activity_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            Marca de temps de l'activitat més recent d'aquest usuari (sessió,
            transacció, canvi d'estat, edició de dades, etc.).
        tags:
          type: array
          items:
            type: object
            properties:
              uuid:
                type: string
                format: uuid
              name:
                type: string
              color:
                type: string
          description: Etiquetes assignades a aquest usuari
        created_at:
          type: string
          format: date-time
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        La clau d'API de la teva aplicació, des de Developers -> API keys a la
        Business Console. La clau primària té accés complet. Una clau amb nom
        pot tenir l'abast limitat: cap, lectura o escriptura per recurs,
        limitada a determinats fluxos de treball o a sessions aprovades, a una
        llista d'adreces IP i a una data de caducitat. 401 significa que la clau
        és incorrecta, revocada o caducada; 403 significa que no s'ha enviat cap
        clau, que la clau no té accés a aquest recurs o acció, o que la
        sol·licitud prové d'una adreça fora de la seva llista d'IP; 404 en una
        ruta de sessió significa que la sessió està fora dels fluxos de treball
        o estats de la clau. Una clau sense accés a fitxers multimèdia rep els
        URL d'imatge, vídeo i PDF com a null, i una clau sense permís
        d'escriptura de sessions rep els enllaços de sessió i els tokens com a
        null. Consulta https://docs.didit.me/console/api-keys.

````

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