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

# Create User API: Сущность пользователя вендора

> Заранее создавайте сущности User в Didit до запуска KYC-сессий. Массовый онбординг из внешних баз или регистрация пользователей для мониторинга транзакций.



Промпт для создания User
        Скопировать промпт в буфер обмена



      
      

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



      
      

Вставьте в

## ОбзорЭтот метод явно создает [объект User](https://docs.didit.me/ru/entities/users/overview.md) до запуска любой сессии.
Созданный объект получает статус `ACTIVE`, если вы не укажете иное.
По желанию тот же вызов отправляет человеку по электронной почте ссылку на верификацию (см. [Отправка ссылки на верификацию](#отправка-ссылки-на-верификацию)).## Когда использовать- **Предварительное заполнение метаданных** (уровень, источник регистрации, внутренние теги) до того, как клиент пройдет верификацию.
- **Миграция от другого поставщика**: воссоздайте существующий список пользователей в Didit, чтобы история и аналитика начинались с известной базовой точки.
- **Импорт доверенных изображений лиц из профилей**: сначала создайте User, затем вызовите [Загрузка лица User](https://docs.didit.me/ru/management-api/users/upload-face.md) с возвращенным `didit_internal_id`.
- **Сценарии только с транзакциями**: зарегистрируйте User с `vendor_data`, чтобы отправлять транзакции без запуска сессии проверки пользователей (KYC).
- **Приглашение на верификацию**: создайте человека и отправьте ему ссылку на верификацию по электронной почте одним вызовом.## Контактные данныеВы можете передать контактные данные человека вместе с полями профиля.
Если `full_name` не передан, `first_name` и `last_name` объединяются через пробел в `full_name`.
`email` и `phone_number` сохраняются в `metadata.contact`, а `country` в `metadata.address`.
`country` принимает код ISO 3166, alpha-2 или alpha-3 (`ES` или `ESP`), и сохраняется в верхнем регистре.Если переданное вами значение `metadata` уже содержит `contact` или `address`, которое не является объектом JSON, Didit не перезаписывает это значение: вызов возвращает `400` с указанием контактного поля, для которого требуется объект JSON.## Отправка ссылки на верификациюУстановите `send_verification_link` в `true`, чтобы пригласить человека пройти верификацию в этом же вызове.
Didit создает для человека сессию верификации по сценарию, указанному в `workflow_id`, и отправляет ссылку на адрес `email`.
Используйте `language`, чтобы выбрать [язык](https://docs.didit.me/ru/integration/supported-languages.md) письма; если параметр не указан, письмо будет на английском.```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` и `workflow_id` обязательны при отправке ссылки, а сценарий должен проверять человека: сценарий Верификации бизнеса (KYB) возвращает `400`.
- Сессия проходит те же проверки, что и в [Создание сессии](https://docs.didit.me/ru/sessions-api/create-session.md).
  Если `vendor_data` попал в список блокировки или недостаточно кредитов, вызов возвращает `400`.
- Человек и сессия создаются вместе или не создаются вовсе.
  Если какая-либо проверка не проходит, ничего не записывается и письмо не отправляется.
- Ответ содержит `verification_link` с `session_id` сессии, `session_number`, `status`, `url`, `workflow_id` и `email`, на который была отправлена ссылка.
  Без ссылки `verification_link` равен `null`.## Примечания- `vendor_data` обязателен и должен быть уникальным для каждого приложения. При попытке создать дубликат возвращается ошибка конфликта. Чтобы обновить существующего пользователя, используйте [`PATCH /v3/users/{vendor_data}/`](https://docs.didit.me/ru/management-api/users/update).
- Длина `vendor_data` ограничена 2000 байтами (в кодировке UTF-8). Значение длиннее этого лимита возвращает ошибку валидации с кодом 400 и не принимается.
- Поля, которые обычно берутся из проверенных сессий (`full_name`, `date_of_birth`), можно заполнить здесь, но их может **перезаписать** первая одобренная сессия проверки пользователей (KYC).
- Этот метод не принимает изображения лиц. Чтобы прикрепить доверенное импортированное изображение лица, после того как метод вернет `didit_internal_id`, используйте [`POST /v3/organization/{organization_id}/application/{application_id}/vendor-users/by-id/{didit_internal_id}/faces/upload/`](https://docs.didit.me/ru/management-api/users/upload-face).
- Само создание не отправляет webhook. Последующие изменения пользователя отправляют `user.data.updated` или `user.status.updated`.
- При `send_verification_link` новая сессия обновляет пользователя в том же вызове, и это отправляет `user.data.updated`.## Права доступаОсновной секретный ключ и [API-ключи](https://docs.didit.me/ru/console/api-keys.md) с полным доступом всегда могут вызывать этот метод.
Ключу с пользовательским доступом нужно право записи в **Люди** (`users`).
При `send_verification_link: true` также нужна запись в **Сессии**, потому что вызов создает сессию и передает ее ссылку.
Без нее вызов возвращает `403` с сообщением `This API key has no write access to sessions.`, и ничего не записывается.
Ключ, ограниченный отдельными сценариями или одобренными сессиями, не может обращаться к этому методу.[Роли и права доступа](https://docs.didit.me/ru/console/roles-permissions.md) в Консоли определяют, что участник команды может делать в Консоли.
Для запросов с API-ключами они не проверяются.## Связанные материалы- [Модель данных User](https://docs.didit.me/ru/entities/users/data-model.md)
- [Загрузка лица User](https://docs.didit.me/ru/management-api/users/upload-face.md)
- [Связывание по vendor\_data](https://docs.didit.me/ru/entities/vendor-data-linking.md)
- [Операции с User](https://docs.didit.me/ru/entities/users/operations.md)


## OpenAPI

````yaml ru/openapi-25.json POST /v3/users/create/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: >-
    API верификации личности. Аутентификация выполняется с помощью заголовка
    x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/users/create/:
    post:
      tags:
        - Users
      summary: Создать пользователя
      description: >-
        Создайте [пользователя](/entities/users) по `vendor_data` до сессии
        верификации или без неё. Поле `vendor_data` должно быть уникальным среди
        пользователей приложения (при обнаружении дубликата возвращается `400`).
        Не идемпотентно.


        **Контактные данные:** `email` и `phone_number` сохраняются в
        `metadata.contact`, а `country` сохраняется в `metadata.address`. Если
        вы передаёте `first_name` или `last_name` без `full_name`, Didit
        объединяет их в `full_name`.


        **Ссылка на верификацию:** при `send_verification_link: true` Didit
        также создаёт для пользователя сессию верификации на основе
        `workflow_id` и отправляет ему ссылку на `email`. В рамках сессии
        выполняются те же проверки, что и в [Создании
        сессии](/ru/sessions-api/create-session), например проверка по списку
        блокировки и проверка баланса кредитов. Пользователь и сессия создаются
        только вместе: если любая из проверок завершается ошибкой, ничего не
        записывается и письмо не отправляется. Поле `verification_link` в ответе
        содержит сведения о сессии, и возвращается `null`, если ссылка не
        запрашивалась.


        **Доступ по API-ключу:** API-ключу с ограниченным доступом требуется
        разрешение на запись в `users`. При `send_verification_link: true` ему
        также требуется разрешение на запись в `sessions`, иначе запрос
        возвращает `403` до внесения каких-либо изменений. Ключи с полным
        доступом работают без изменений. См. [API-ключи](/ru/console/api-keys).
      operationId: create_user
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - vendor_data
              properties:
                vendor_data:
                  type: string
                  description: >-
                    Ваш уникальный идентификатор этого пользователя
                    (произвольная строка, НЕ UUID). Должен быть уникальным среди
                    пользователей приложения; сопоставляется в точности в
                    переданном виде.
                full_name:
                  type: string
                  nullable: true
                  maxLength: 512
                  description: Полное юридическое имя пользователя.
                display_name:
                  type: string
                  nullable: true
                  description: >-
                    Понятное отображаемое имя, показываемое в консоли (имеет
                    приоритет над `full_name` при отображении в интерфейсе).
                  maxLength: 255
                date_of_birth:
                  type: string
                  format: date
                  nullable: true
                  description: Дата рождения в формате `YYYY-MM-DD`.
                status:
                  type: string
                  enum:
                    - ACTIVE
                    - FLAGGED
                    - BLOCKED
                  default: ACTIVE
                  description: Начальный статус жизненного цикла. По умолчанию `ACTIVE`.
                metadata:
                  type: object
                  nullable: true
                  description: >-
                    Произвольный JSON-объект, прикрепляемый к пользователю. По
                    умолчанию `{}`.
                approved_emails:
                  type: array
                  items:
                    type: string
                  description: >-
                    Заранее добавленные в доверенные адреса электронной почты
                    для этого пользователя, например `["john@example.com"]`.
                approved_phones:
                  type: array
                  items:
                    type: string
                  description: >-
                    Заранее добавленные в доверенные номера телефонов для этого
                    пользователя, например `["+14155551234"]`.
                issuing_states:
                  type: array
                  items:
                    type: string
                  description: >-
                    Заранее указанные страны выдачи (ISO 3166-1 alpha-3),
                    например `["USA"]`.
                first_name:
                  type: string
                  maxLength: 255
                  description: >-
                    Имя. Если `full_name` не передан, Didit объединяет
                    `first_name` и `last_name` через пробел в `full_name`. Не
                    возвращается отдельным полем.
                last_name:
                  type: string
                  maxLength: 255
                  description: >-
                    Фамилия. Объединяется с `first_name` в `full_name`, если
                    `full_name` не передан. Не возвращается отдельным полем.
                email:
                  type: string
                  format: email
                  description: >-
                    Контактный email, сохраняемый в `metadata.contact.email`
                    (заменяет `email`, переданный вами внутри
                    `metadata.contact`). Обязателен, если
                    `send_verification_link` равен `true`: ссылка отправляется
                    на этот адрес. Если `metadata.contact` не является объектом
                    JSON, вызов возвращает ошибку `400` для этого поля.
                phone_number:
                  type: string
                  maxLength: 32
                  description: >-
                    Контактный номер телефона, сохранённый в
                    `metadata.contact.phone_number`. Если `metadata.contact` не
                    является JSON-объектом, вызов возвращает `400` для этого
                    поля.
                country:
                  type: string
                  maxLength: 3
                  description: >-
                    Страна в виде кода ISO 3166, alpha-2 или alpha-3 (`ES` или
                    `ESP`). Сохраняется в верхнем регистре в
                    `metadata.address.country`. Если `metadata.address` не
                    является JSON-объектом, вызов вернёт `400` для этого поля.
                send_verification_link:
                  type: boolean
                  default: false
                  description: >-
                    Когда `true`, Didit создает сессию верификации для человека
                    по `workflow_id` и отправляет ему ссылку по электронной
                    почте на `email`. Требуются `email` и `workflow_id`.
                    API-ключу с ограниченной областью действия также требуется
                    разрешение на запись в `sessions`.
                workflow_id:
                  type: string
                  format: uuid
                  description: >-
                    Сценарий сессии верификации. Обязателен, если
                    `send_verification_link` имеет значение `true`. Должен
                    верифицировать физическое лицо: сценарий Верификация бизнеса
                    (KYB) будет отклонён. В остальных случаях игнорируется.
                language:
                  type: string
                  maxLength: 10
                  description: >-
                    Язык письма для верификации в виде кода [поддерживаемого
                    языка](/ru/integration/supported-languages). Если значение
                    не указано, используется английский. Игнорируется, если
                    `send_verification_link` не равен `true`.
            examples:
              Basic:
                summary: Создать с базовой информацией
                value:
                  vendor_data: user-abc-123
                  full_name: John Doe
              Full:
                summary: Все поля
                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: Имя, адрес электронной почты, номер телефона и страна
                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: >-
                  Создать физлицо и отправить ему ссылку на верификацию по
                  электронной почте
                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: >-
            Пользователь создан. Полная запись пользователя (такой же структуры,
            как в Get User), а также `verification_link`: сессия верификации,
            отправленная Didit по электронной почте, если
            `send_verification_link` был равен `true`, иначе `null`.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/UserDetailItem'
                  - type: object
                    required:
                      - verification_link
                    properties:
                      verification_link:
                        type: object
                        nullable: true
                        description: >-
                          Сессия верификации, созданная Didit и отправленная
                          пользователю по электронной почте. Присутствует
                          всегда: `null`, если `send_verification_link` не был
                          равен `true`.
                        required:
                          - session_id
                          - session_number
                          - status
                          - url
                          - workflow_id
                          - email
                        properties:
                          session_id:
                            type: string
                            format: uuid
                            description: ID сессии верификации.
                          session_number:
                            type: integer
                            description: Порядковый номер сессии внутри вашего приложения.
                          status:
                            type: string
                            description: >-
                              Статус сессии; `Not Started` для только что
                              созданной сессии.
                          url:
                            type: string
                            format: uri
                            description: >-
                              Ссылка на верификацию, отправленная Didit
                              пользователю по электронной почте.
                          workflow_id:
                            type: string
                            format: uuid
                            nullable: true
                            description: Сценарий, который выполняет сессия.
                          email:
                            type: string
                            format: email
                            description: Адрес, на который была отправлена ссылка.
              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: >-
            Недопустимое тело запроса с разбивкой по полям: обычно дубликат
            `vendor_data`, отсутствие обязательного поля или некорректное
            значение. При `send_verification_link: true` также отсутствие
            `email` или `workflow_id`, неизвестный сценарий или сценарий
            Верификация бизнеса (KYB), неподдерживаемый `language` (с ключом
            `contact_details.email_lang`), `vendor_data` из списка блокировки
            или недостаточное количество кредитов для запуска сессии. Никаких
            данных не записано.
          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: >-
            Учетные данные не переданы. Запросы к путям `/v3/users/*` без
            заголовка `x-api-key` (или токена `Authorization: Bearer`)
            отклоняются промежуточным ПО аутентификации до попадания в API.
          content:
            application/json:
              examples:
                Missing credentials:
                  value:
                    detail: >-
                      You must be authenticated with a valid access token to
                      access this endpoint.
        '403':
          description: >-
            Недействительный или отозванный API-ключ, либо ключ не может
            создавать пользователей для этого приложения. API-ключу с
            ограниченной областью действия требуется разрешение на запись
            `users`, а также запись `sessions`, если `send_verification_link`
            равен `true`; никакие данные не записаны. При отсутствии ключа
            возвращается `403`; при неверном, отозванном или истёкшем ключе
            возвращается `401`.
          content:
            application/json:
              examples:
                Forbidden:
                  value:
                    detail: You do not have permission to perform this action.
                No sessions write:
                  summary: >-
                    Ключ с ограниченной областью действия запрашивает ссылку на
                    верификацию без прав на запись сессий
                  value:
                    detail: This API key has no write access to sessions.
        '429':
          description: >-
            Лимит запросов превышен; снизьте частоту запросов и повторите
            попытку через интервал, указанный в `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: >-
        Полные сведения о пользователе. Дополняет UserListItem метаданными,
        комментариями и updated_at.
      allOf:
        - $ref: '#/components/schemas/UserListItem'
        - type: object
          properties:
            metadata:
              type: object
              description: >-
                JSON с пользовательскими метаданными, прикреплённый вами к этому
                пользователю. По умолчанию: `{}`.
            tags:
              type: array
              description: >-
                Назначения тегов. ПРИМЕЧАНИЕ: в подробных ответах каждая запись
                представляет собой объект-связку тега (`{uuid, tag: {...},
                added_by_email, added_by_name, created_at}`), в отличие от
                плоской структуры `{uuid, name, color}`, используемой в ответах
                со списком.
              items:
                type: object
                properties:
                  uuid:
                    type: string
                    format: uuid
                    description: UUID назначения тега (не самого тега).
                  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: Предыдущие значения полей для записей PROFILE_UPDATED.
                  new_value:
                    type: object
                    nullable: true
                    description: Новые значения полей для записей PROFILE_UPDATED.
                  changed_fields:
                    type: array
                    items:
                      type: string
                    description: Названия полей, изменённых записью PROFILE_UPDATED.
                  metadata:
                    type: object
                    nullable: true
                  mentioned_emails:
                    type: array
                    items:
                      type: string
                  created_at:
                    type: string
                    format: date-time
              description: >-
                Журнал действий и комментарии по этому пользователю (изменения
                статуса, правки профиля, ручные заметки).
            updated_at:
              type: string
              format: date-time
    UserListItem:
      type: object
      description: Верифицированный пользователь.
      properties:
        didit_internal_id:
          type: string
          format: uuid
          description: Стабильный внутренний UUID Didit для этого пользователя.
        vendor_data:
          type: string
          nullable: true
          description: >-
            Ваш уникальный идентификатор этого пользователя (передаётся при
            создании сессий). Может быть равен null, если идентификатор
            поставщика не был передан.
        display_name:
          type: string
          nullable: true
          description: Пользовательское отображаемое имя, заданное вами
        full_name:
          type: string
          nullable: true
          description: Полное имя, извлечённое из верифицированных документов
        date_of_birth:
          type: string
          format: date
          nullable: true
        effective_name:
          type: string
          nullable: true
          description: 'Наиболее подходящее имя: display_name, если задано, иначе full_name'
        status:
          type: string
          enum:
            - ACTIVE
            - FLAGGED
            - BLOCKED
          description: >-
            Статус жизненного цикла записи пользователя (НЕ статус сессии).
            `ACTIVE` используется по умолчанию, `FLAGGED` помечает пользователя
            для ручной проверки, `BLOCKED` запрещает новые сессии для этого
            `vendor_data`.
        portrait_image_url:
          type: string
          nullable: true
          description: >-
            Предварительно подписанный URL портретного фото пользователя (срок
            действия истекает через несколько часов)
        session_count:
          type: integer
          description: Общее количество сессий верификации для этого пользователя
        approved_count:
          type: integer
          description: Количество одобренных сессий
        declined_count:
          type: integer
          description: Количество отклонённых сессий
        in_review_count:
          type: integer
          description: Количество сессий на проверке
        issuing_states:
          type: array
          items:
            type: string
          description: >-
            Коды стран выдачи по стандарту ISO 3166-1 alpha-3, указанные в
            одобренных документах, удостоверяющих личность этого пользователя,
            например `["USA", "ESP"]`. Пустой массив, если таких кодов нет.
        approved_emails:
          type: array
          items:
            type: string
          description: >-
            Подтверждённые адреса электронной почты, собранные из одобренных
            сессий этого пользователя, например `["john@example.com"]`.
        approved_phones:
          type: array
          items:
            type: string
          description: >-
            Подтверждённые номера телефонов, собранные из одобренных сессий
            этого пользователя, например `["+14155551234"]`.
        features:
          type: object
          description: >-
            Агрегированный статус по функциям среди всех сессий этого
            пользователя. Возможные ключи: `ID_VERIFICATION`, `NFC`, `LIVENESS`,
            `FACE_MATCH`, `POA`, `QUESTIONNAIRE`, `EMAIL_VERIFICATION`, `PHONE`,
            `AML`, `IP_ANALYSIS`, `AGE_ESTIMATION`, `DATABASE_VALIDATION`.
            Возможные значения: `Approved`, `Declined`, `In Review`, `Not
            Finished`, `Resub Requested`.
        features_list:
          type: array
          items:
            type: object
            properties:
              feature:
                type: string
              status:
                type: string
          description: >-
            Те же данные, что и `features`, в виде упорядоченного массива
            объектов `{feature, status}`.
        last_session_at:
          type: string
          format: date-time
          nullable: true
          description: Временная метка последней сессии
        first_session_at:
          type: string
          format: date-time
          nullable: true
          description: Временная метка первой сессии
        last_activity_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            Временная метка последней активности по этому пользователю (сессия,
            транзакция, смена статуса, редактирование данных и т. д.).
        tags:
          type: array
          items:
            type: object
            properties:
              uuid:
                type: string
                format: uuid
              name:
                type: string
              color:
                type: string
          description: Теги, назначенные этому пользователю
        created_at:
          type: string
          format: date-time
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API-ключ вашего приложения из раздела «Разработчикам» -> «API-ключи» в
        Business Console. Основной ключ имеет полный доступ. Именованный ключ
        может иметь ограниченную область действия: без доступа, чтение или
        запись для каждого ресурса, ограничение определенными сценариями или
        одобренными сессиями, списком IP-адресов и сроком действия. 401
        означает, что ключ неверен, отозван или его срок действия истек; 403
        означает, что ключ не был передан, у ключа нет доступа к этому ресурсу
        или действию, либо запрос поступил с адреса вне его списка IP-адресов;
        404 на маршруте сессии означает, что сессия не входит в сценарии или
        статусы ключа. Ключ без доступа к медиа получает URL изображений, видео
        и PDF как null, а ключ без прав на запись сессий получает ссылки на
        сессии и токены как null. См. https://docs.didit.me/console/api-keys.

````

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