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

# Didit API: запись в списке блокировки и разрешений

> Добавьте лицо, документ, IP, кошелёк, email или телефон в список блокировки или разрешённых Didit. Автоматизируйте контроль комплаенса и фрода.



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



      
      

\<pre>

\`Add an entry to a Didit list (blocklist, allowlist, or custom) through the Management API.

Endpoint:
POST https://verification.didit.me/v3/lists/{list_uuid}/entries/

Authentication:
Use the x-api-key header with my Didit API key. A scoped API key needs workflows: write.

Goal:
\- Insert a single entry into a list. Three add modes are supported:
1\. By value: pass value matching the list's entry_type.
2\. From a verification session: pass reference_session_id and Didit reads the value from the session's most recent record of the list's entry_type (face, document, phone, email, ip_address, device_fingerprint) and links the entry to the session.
3\. With a source reference: pass value plus reference_object_uuid and metadata.reference_type so the console links the entry back to the transaction, user or business it came from.

Path parameter:
\- list_uuid: list UUID from GET /v3/lists/. For a face without a session, use POST /v3/lists/{list_uuid}/entries/face-upload/ instead.

Request body (application/json):
\{
"value": "string",                  // required unless reference_session_id is sent
"reference_session_id": "uuid",     // optional: read the value from this session of my application
"reference_object_uuid": "uuid",    // optional: transaction UUID, or didit_internal_id of a user or business
"face_image_source": "liveness" | "front_image_camera_front" | "back_image_camera_front", // optional, system face blocklist + reference_session_id only; default liveness
"reference_node_id": "string",      // optional, with a document-capture face_image_source: which ID verification node's selfie to use
"display_label": "string",          // optional, at most 512 characters
"comment": "string",                // optional, reason or note
"metadata": {                       // optional, free-form; reference_image_url and front_image_url are ignored
"reference_type": "transaction" | "vendor_user" | "vendor_business",
"reference_id": "uuid"
}
}

Value validation by entry_type:
\- email: valid email address.
\- phone: valid international phone number (stored in E.164).
\- ip_address: IP address or CIDR range (e.g. 10.0.0.0/8).
\- device_fingerprint: at least 8 characters among letters, digits, -, _, : and . (a blocklist refuses a fingerprint that several distinct devices have reported).
\- country: ISO 3166-1 alpha-2 or alpha-3 (stored as alpha-3).
\- user, business: the vendor_data to block.
\- face, document, wallet_address, bank_account, key: any non-empty string.
Values are case-insensitive: country codes are stored in upper case, phone numbers in E.164, everything else in lower case.
A list holds each value once: adding a value that is already there returns 400.

Adding from a session, what Didit does:
\- Looks up the session (it must belong to the same application).
\- Reads the value from the session's most recent record of the list's entry_type:
\- face: the liveness face (value is the face UUID). With face_image_source = front_image_camera_front / back_image_camera_front, the face from the selfie the front camera took while the user photographed the front / back of their document instead (system face blocklist only, leave value empty).
\- document: the document number; full_name, issuing_state, document_type, region and document_number go into metadata.
\- phone / email: the phone number / email address.
\- ip_address: the session's IP address.
\- device_fingerprint: a fingerprint that identifies one device. On a blocklist, Didit refuses a session that only has a device-class fingerprint or was completed on more than one device; pass the exact fingerprint as value in that case.
\- Links the entry to the session (reference_session_id) and to that record (reference_object_uuid).
\- If I also send value, Didit stores my value but still links the most recent record. To list a value from an earlier record, add it by value without reference_session_id.

Example calls:
\# By value
curl -X POST "https://verification.didit.me/v3/lists/{list_uuid}/entries/" \
-H "x-api-key: YOUR_API_KEY" -H "Content-Type: application/json" \
-d '{"value": "+14155552671", "comment": "Reported fraud"}'

\# From a session
curl -X POST "https://verification.didit.me/v3/lists/{list_uuid}/entries/" \
-H "x-api-key: YOUR_API_KEY" -H "Content-Type: application/json" \
-d '{"reference_session_id": "33333333-4444-5555-6666-777777777777"}'

\# The face from the selfie taken during document capture (system face blocklist)
curl -X POST "https://verification.didit.me/v3/lists/{list_uuid}/entries/" \
-H "x-api-key: YOUR_API_KEY" -H "Content-Type: application/json" \
-d '{"reference_session_id": "33333333-4444-5555-6666-777777777777", "face_image_source": "front_image_camera_front"}'

\# From a transaction
curl -X POST "https://verification.didit.me/v3/lists/{list_uuid}/entries/" \
-H "x-api-key: YOUR_API_KEY" -H "Content-Type: application/json" \
-d '{"value": "0x52908400098527886E0F7030069857D2E4169EE7", "reference_object_uuid": "55555555-6666-7777-8888-999999999999", "metadata": {"reference_type": "transaction"}}'

Failure modes:
\- 400: value fails the entry_type validator or is already in the list, neither value nor reference_session_id was sent, reference_session_id is not a session of this application, or the session has no data of the list's entry_type.
\- 400 (face_image_source): the list is not the system face blocklist, value was sent, the session has no image for that source, no clear face was found in that selfie, or that selfie is already in the blocklist.
\- 401: the API key has expired.
\- 403: missing x-api-key (a wrong, revoked or expired key gets 401) ({ "detail": "You do not have permission to perform this action." }), or a scoped key without workflows: write.
\- 404: list not found in this application ({ "detail": "List not found." }).
\- 503 (face_image_source): face analysis is temporarily unavailable; nothing was added, retry later.
\- 429: rate limited (see /integration/rate-limiting); back off and retry.

Side effects:
\- System face, document, phone and email blocklists: a record read from a session is flagged as blocklisted at once, and new sessions that match it are declined.
\- System user and business blocklists: users or businesses of the application whose vendor_data equals value (or whose UUID equals reference_object_uuid) are set to BLOCKED.
\- Sessions and transactions that already finished are not changed.

For the full integration shape, see /integration/integration-prompt.`

\</pre>



      
      

Вставьте в

Добавляет запись в список. Значение проверяется по типу записей этого списка:* **email**: корректный адрес электронной почты
* **phone**: корректный международный номер телефона в формате E.164 (например, `+14155552671`)
* **ip\_address**: корректный IP-адрес или диапазон CIDR (например, `192.168.1.1` или `10.0.0.0/8`)
* **device\_fingerprint**: не менее 8 символов из букв, цифр, `-`, `_`, `:` и `.`. Список блокировки отклоняет отпечаток, который сообщили несколько разных устройств, потому что его блокировка привела бы к отклонению заявок от несвязанных с ним людей.
* **country**: корректный [код страны по ISO 3166-1 alpha-3](https://docs.didit.me/ru/core-technology/id-verification/supported-documents-id-verification.md) (например, `USA`, `GBR`, `ESP`). Коды alpha-2 (например, `US`) принимаются и автоматически преобразуются в alpha-3.
* **user**, **business**: значение `vendor_data` пользователя или компании
* **face**, **document**, **wallet\_address**, **bank\_account**, **key**: любая непустая строка> [!NOTE]
>
> Все значения записей **не учитывают регистр**. Отправленные значения нормализуются при сохранении (номера телефонов в E.164, коды стран в верхнем регистре, всё остальное в нижнем) и сравниваются без учёта регистра при верификации. Например, блокировка `User@Example.COM` также поймает `user@example.com`. Каждое значение в списке хранится один раз: добавление значения, которое уже есть в списке, возвращает `400`.Для лица используйте [Загрузка лица](https://docs.didit.me/ru/management-api/lists/upload-face.md), если у вас есть только изображение, или передайте `reference_session_id`, чтобы взять лицо из существующей сессии. Запись о лице требует сохранённого лица для сравнения, которое не передаётся в текстовом `value`.## Добавление из сессииКогда вы передаёте `reference_session_id`, Didit:1) Находит сессию (она должна принадлежать тому же приложению)
2) Берёт значение из **самой последней** записи сессии того типа, который соответствует типу записей списка:
   * **face**: лицо из селфи проверки живости; `value` содержит UUID лица
   * **document**: номер документа; полное имя, государство выдачи, тип документа, регион и номер документа сохраняются в `metadata`, а `display_label` по умолчанию равен имени владельца и номеру документа
   * **phone**: номер телефона
   * **email**: адрес электронной почты
   * **ip\_address**: IP-адрес сессии
   * **device\_fingerprint**: отпечаток, который идентифицирует одно устройство, с приоритетом устройства, на котором пройден шаг верификации. В списке блокировки Didit отклоняет сессию, в которой есть только отпечаток класса устройства или которая была завершена более чем на одном устройстве: в этом случае передайте точный отпечаток в `value`.
3) Связывает запись с сессией (`reference_session_id`) и с записью (`reference_object_uuid`) для отслеживанияВ системных списках блокировки лиц, документов, телефонов и email запись также помечается как находящаяся в списке блокировки, поэтому новые сессии, которые с ней совпадают, отклоняются. Для любого другого типа записей передавайте также `value`.Возвращает `400`, если сессия не найдена или не содержит данных для запрошенного типа записи.### Лица из селфи при съёмке документаПока пользователь фотографирует документ, фронтальная камера может сделать селфи пользователя (изображения `front_image_camera_front` и `back_image_camera_front` из [отчёта о верификации личности](https://docs.didit.me/ru/core-technology/id-verification/report-id-verification.md)). Это лицо можно добавить в список блокировки лиц наряду с лицом из проверки живости: передайте `face_image_source` с нужным изображением.```json theme={null}
{
  "reference_session_id": "33333333-4444-5555-6666-777777777777",
  "face_image_source": "front_image_camera_front"
}
```- Запись создаётся только в системном **списке блокировки лиц**, а `value` нужно оставить пустым: Didit берёт лицо из селфи сессии.
- Селфи должно содержать одно чётко различимое лицо. Если это не так, запрос возвращает `400`, и ничего не добавляется.
- Каждое селфи можно добавить только один раз. `metadata.face_image_source` и `metadata.reference_node_id` показывают, из какого селфи взято лицо.
- В сценарии с несколькими шагами верификации личности `reference_node_id` выбирает шаг, селфи которого нужно использовать. По умолчанию Didit использует самую последнюю верификацию личности, в которой есть это селфи.
- С этого момента лицо проверяется так же, как любое другое заблокированное лицо: сравнивается с селфи проверки живости каждой новой сессии и с каждым новым селфи при съёмке документа (см. [`FRONT_CAMERA_FACE_IN_BLOCKLIST`](https://docs.didit.me/ru/core-technology/id-verification/warnings-id-verification)).
- Удаление записи убирает лицо из списка блокировки, и оно перестаёт совпадать с новыми сессиями.### Сессии с несколькими записями одного типаСессия может содержать несколько записей одного типа, например два номера телефона из многошагового сценария. Didit всегда берёт **самую последнюю** запись. Если вы передаёте `value` вместе с `reference_session_id`, запись сохраняет ваше `value`, но всё равно связывается с самой последней записью, а в системном списке блокировки помечается именно она.Чтобы добавить значение из более ранней записи, передайте только `value`, без `reference_session_id`:```json theme={null}
{
  "value": "+34612345678",
  "comment": "First phone number of session 42"
}
```## Ссылки на транзакции, пользователей и компанииКогда вы добавляете в список блокировки данные из транзакции или пользователя либо компании вендора, передайте UUID этого объекта в `reference_object_uuid` и укажите тип источника в `metadata`:```json theme={null}
{
  "value": "0x52908400098527886E0F7030069857D2E4169EE7",
  "reference_object_uuid": "55555555-6666-7777-8888-999999999999",
  "metadata": {
    "reference_type": "transaction",
    "reference_id": "55555555-6666-7777-8888-999999999999"
  }
}
```Это позволяет перейти от записи списка блокировки к исходной транзакции, пользователю или компании в консоли. Didit сохраняет ключи `metadata`, которые вы передали, кроме `reference_image_url` и `front_image_url`: их устанавливает только Didit. Для записи, прочитанной из сессии, Didit добавляет свои ключи к вашим, и её ключи имеют приоритет.| Источник | `reference_object_uuid` | `metadata.reference_type` |
| - | - | - |
| Сессия верификации | Задаёт Didit (запись о лице, документе, телефоне или email) | Не требуется: используйте `reference_session_id` |
| Транзакция | UUID транзакции | `"transaction"` |
| Пользователь вендора | `didit_internal_id` | `"vendor_user"` |
| Компания вендора | `didit_internal_id` | `"vendor_business"` |В системных списках блокировки **Пользователь** и **Компании** Didit также переводит соответствующих пользователей или компании в статус `BLOCKED`: тех, у которых `vendor_data` равен `value`, или тех, у которых `didit_internal_id` равен `reference_object_uuid`. См. [Список блокировки пользователей](https://docs.didit.me/ru/entities/users/blocklist.md) и [Список блокировки компаний](https://docs.didit.me/ru/entities/businesses/blocklist.md).


## OpenAPI

````yaml ru/openapi-25.json POST /v3/lists/{list_uuid}/entries/
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/lists/{list_uuid}/entries/:
    post:
      tags:
        - Lists
      summary: Создать запись в списке
      description: >-
        Добавляет одну запись в список одним из трех способов: по `value`; из
        сессии верификации с `reference_session_id`, где Didit считывает
        значение из самой последней записи сессии для типа записи списка и
        связывает запись с ней; или по `value` с `reference_object_uuid` и
        `metadata.reference_type`, указывающими на транзакцию, пользователя или
        компанию. В системных списках блокировки лиц, документов, телефонов и
        email запись, считанная из сессии, также помечается как добавленная в
        список блокировки, поэтому новые совпадающие сессии будут отклонены; в
        системных списках блокировки пользователей и компаний совпадающие
        пользователи или компании переводятся в статус `BLOCKED`. Уже
        завершенные сессии и транзакции не изменяются. Для ограниченного
        API-ключа требуется разрешение `workflows: write`. См. раздел [Создание
        записи
        списка](https://docs.didit.me/ru/management-api/lists/create-entry) для
        каждого режима.
      operationId: create_list_entry
      parameters:
        - name: list_uuid
          in: path
          required: true
          description: >-
            UUID списка, в который нужно добавить запись. Если лицо есть только
            в виде изображения, используйте вместо этого Upload a face to a
            list.
          schema:
            type: string
            format: uuid
          example: 11111111-2222-3333-4444-555555555555
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: >-
                Отправьте `value`, `reference_session_id` или оба параметра.
                Какие поля применимы, зависит от `entry_type` списка.
              properties:
                value:
                  type: string
                  description: >-
                    Значение для включения в список, проверяемое на соответствие
                    параметру списка `entry_type`: для `email`: корректный адрес
                    электронной почты; для `phone`: корректный международный
                    номер, сохраняемый в формате E.164; для `ip_address`:
                    IP-адрес или CIDR-диапазон (например, `10.0.0.0/8`); для
                    `device_fingerprint`: не менее 8 символов, состоящих из
                    букв, цифр, `-`, `_`, `:` и `.` (список блокировки отклоняет
                    отпечаток, о котором сообщили несколько различных
                    устройств); для `country`: код ISO 3166-1 alpha-2 или
                    alpha-3, сохраняемый как alpha-3; для `user` и `business`:
                    значение `vendor_data`; для любого другого типа: непустая
                    строка. Сохраняется в нижнем регистре, за исключением
                    телефонных номеров и кодов стран, при этом список содержит
                    каждое значение только один раз (без учёта регистра).
                    Обязательно, если не передан `reference_session_id`; должно
                    оставаться пустым при `face_image_source` с захватом
                    документа.
                reference_session_id:
                  type: string
                  format: uuid
                  description: >-
                    Сессия верификации личности или компании вашего приложения,
                    из которой берётся значение. Didit считывает самую последнюю
                    запись сессии для указанного типа (`face`, `document`,
                    `phone`, `email`, `ip_address` или `device_fingerprint`),
                    связывает запись списка с сессией и этой записью, а также
                    заполняет `display_label` и `metadata` для документов. Для
                    списка блокировки типа `device_fingerprint` сессия, имеющая
                    только отпечаток класса устройства или завершённая более чем
                    на одном устройстве, отклоняется: передайте точный
                    фингерпринт в качестве `value`. Для других типов записей или
                    если в сессии нет такой записи, также передайте `value`; в
                    этом случае ваше значение `value` сохраняется, а запись всё
                    равно связывается с сессией.
                reference_object_uuid:
                  type: string
                  format: uuid
                  description: >-
                    UUID записи, которой соответствует элемент, если он получен
                    не из сессии: UUID транзакции или `didit_internal_id`
                    пользователя либо компании. Используйте в паре с
                    `metadata.reference_type`. Заменяется записью сессии, если
                    указан `reference_session_id`.
                face_image_source:
                  type: string
                  enum:
                    - liveness
                    - front_image_camera_front
                    - back_image_camera_front
                  default: liveness
                  description: >-
                    Списки лиц с `reference_session_id`: из какого изображения
                    сессии взято лицо. `liveness` (по умолчанию) означает селфи
                    проверки живости. `front_image_camera_front` и
                    `back_image_camera_front` представляют собой селфи,
                    сделанные фронтальной камерой во время фотографирования
                    пользователем лицевой или обратной стороны документа:
                    принимаются только в системном списке блокировки лиц, с
                    `reference_session_id` и пустым `value`. Каждое селфи можно
                    добавить один раз, и на нем должно быть четко видно одно
                    лицо.
                reference_node_id:
                  type: string
                  nullable: true
                  maxLength: 100
                  description: >-
                    При `face_image_source` из захвата документа: узел
                    верификации личности, чьё селфи использовать (для сценариев
                    с несколькими узлами). По умолчанию используется самая
                    последняя верификация личности с этим изображением.
                    Отклоняется при `liveness`.
                display_label:
                  type: string
                  maxLength: 512
                  description: >-
                    Понятная метка. Если она пуста, Didit формирует её на основе
                    сессии, где это возможно (например, имя владельца и номер
                    документа).
                comment:
                  type: string
                  description: >-
                    Примечание в виде произвольного текста, например причина
                    включения в список.
                metadata:
                  type: object
                  additionalProperties: true
                  description: >-
                    JSON в свободной форме, сохраняемый с записью и возвращаемый
                    в сохранённом виде. Используйте `reference_type` и
                    `reference_id`, чтобы консоль ссылалась на первоисточник.
                    Поля `reference_image_url` и `front_image_url` задаются
                    только Didit и игнорируются при их отправке вами. Для
                    записи, считанной из сессии, ключи Didit объединяются с
                    вашими.
                  properties:
                    reference_type:
                      type: string
                      enum:
                        - transaction
                        - vendor_user
                        - vendor_business
                      description: На что указывает `reference_object_uuid`.
                    reference_id:
                      type: string
                      description: Идентификатор исходной записи.
            examples:
              By value:
                value:
                  value: '+14155552671'
                  comment: Reported fraud
              From a session:
                value:
                  reference_session_id: 33333333-4444-5555-6666-777777777777
              Face from a document-capture selfie:
                value:
                  reference_session_id: 33333333-4444-5555-6666-777777777777
                  face_image_source: front_image_camera_front
              From a transaction:
                value:
                  value: '0x52908400098527886E0F7030069857D2E4169EE7'
                  reference_object_uuid: 55555555-6666-7777-8888-999999999999
                  comment: Linked to a chargeback
                  metadata:
                    reference_type: transaction
                    reference_id: 55555555-6666-7777-8888-999999999999
              Country:
                value:
                  value: PRK
                  comment: Sanctioned jurisdiction
      responses:
        '201':
          description: Запись была создана.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComplianceListEntry'
              examples:
                By value:
                  value:
                    uuid: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
                    value: '+14155552671'
                    display_label: ''
                    comment: Reported fraud
                    added_by: api
                    reference_session_id: null
                    reference_session_number: null
                    reference_session_type: null
                    reference_object_uuid: null
                    metadata: null
                    created_at: '2026-10-12T10:04:51.220391Z'
                Document from a session:
                  value:
                    uuid: bbbbbbbb-cccc-dddd-eeee-ffffffffffff
                    value: X1234567
                    display_label: Jane Doe - X1234567
                    comment: ''
                    added_by: api
                    reference_session_id: 33333333-4444-5555-6666-777777777777
                    reference_session_number: 1042
                    reference_session_type: kyc
                    reference_object_uuid: 66666666-7777-8888-9999-000000000000
                    metadata:
                      full_name: Jane Doe
                      issuing_state: ESP
                      document_type: ID
                      region: ''
                      document_number: X1234567
                    created_at: '2026-10-12T10:06:12.774915Z'
                From a transaction:
                  value:
                    uuid: dddddddd-eeee-ffff-0000-111111111111
                    value: '0x52908400098527886e0f7030069857d2e4169ee7'
                    display_label: ''
                    comment: Linked to a chargeback
                    added_by: api
                    reference_session_id: null
                    reference_session_number: null
                    reference_session_type: null
                    reference_object_uuid: 55555555-6666-7777-8888-999999999999
                    metadata:
                      reference_type: transaction
                      reference_id: 55555555-6666-7777-8888-999999999999
                    created_at: '2026-10-12T10:20:40.117062Z'
        '400':
          description: >-
            Некорректное тело запроса, значение уже находится в списке или
            сессия не может предоставить это значение.
          content:
            application/json:
              examples:
                Nothing to list:
                  value:
                    value:
                      - >-
                        Either 'value' or 'reference_session_id' must be
                        provided.
                Duplicate value:
                  value:
                    value:
                      - An entry with this value already exists in this list.
                Invalid phone:
                  value:
                    value:
                      - >-
                        Invalid phone number. Provide a valid international
                        number (e.g. +1234567890).
                Invalid IP:
                  value:
                    value:
                      - >-
                        Invalid IP address or CIDR range (e.g. 192.168.1.1 or
                        10.0.0.0/24).
                Invalid country:
                  value:
                    value:
                      - >-
                        Invalid country code: XX. Provide a valid ISO 3166-1
                        alpha-2 or alpha-3 country code.
                Device-class fingerprint:
                  value:
                    value:
                      - >-
                        This value is a device-class fingerprint: several
                        distinct devices have reported it, so blocklisting it
                        would decline unrelated people. Block the user by
                        document, face, email or phone instead.
                Unknown session:
                  value:
                    reference_session_id:
                      - >-
                        Session not found or does not belong to this
                        application.
                No data in session:
                  value:
                    value:
                      - >-
                        Either provide a 'value' or ensure the session contains
                        data for this entry type.
                Selfie on another list:
                  value:
                    face_image_source:
                      - >-
                        A document-capture selfie can only be added to the face
                        blocklist.
                No clear face in selfie:
                  value:
                    face_image_source:
                      - >-
                        No clear face was found in this selfie, so it cannot be
                        blocklisted.
                Selfie already listed:
                  value:
                    face_image_source:
                      - This selfie is already in the blocklist.
        '401':
          description: >-
            Срок действия API-ключа с ограниченной областью действия истёк.
            Другие ошибки аутентификации возвращают `403`.
          content:
            application/json:
              examples:
                Expired API key:
                  value:
                    detail: This API key has expired.
        '403':
          description: >-
            Заголовок `x-api-key` отсутствует (при неверном, отозванном или
            истёкшем ключе возвращается `401`), либо API-ключ с ограниченной
            областью действия не имеет разрешения `workflows: write` или
            используется с IP-адреса вне своего списка разрешённых.
          content:
            application/json:
              examples:
                Missing or invalid API key:
                  value:
                    detail: You do not have permission to perform this action.
                Scoped key without workflows access:
                  value:
                    detail: This API key has no write access to workflows.
        '404':
          description: >-
            Списка с таким UUID не существует в приложении этого API-ключа, или
            он был удален.
          content:
            application/json:
              examples:
                Not found:
                  value:
                    detail: List not found.
        '429':
          $ref: '#/components/responses/RateLimitedWrite'
        '503':
          description: >-
            Анализ лица по селфи, полученному при захвате документа, временно
            недоступен. Ничего не добавлено; повторите попытку позже.
          content:
            application/json:
              examples:
                Unavailable:
                  value:
                    detail: Service temporarily unavailable. Please try again later.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl -X POST
            'https://verification.didit.me/v3/lists/11111111-2222-3333-4444-555555555555/entries/'
            \
              -H 'x-api-key: YOUR_API_KEY' \
              -H 'Content-Type: application/json' \
              -d '{"value": "+14155552671", "comment": "Reported fraud"}'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.lists.entries.create(
                "11111111-2222-3333-4444-555555555555",
                value="+14155552671",
                comment="Reported fraud",
            )
            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.lists.entries.create("11111111-2222-3333-4444-555555555555", {
              value: "+14155552671",
              comment: "Reported fraud",
            });

            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Lists.Entries.Create(ctx, \"11111111-2222-3333-4444-555555555555\", didit.ListsEntriesCreateParams{\n\tValue:   didit.String(\"+14155552671\"),\n\tComment: didit.String(\"Reported fraud\"),\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.ListsEntriesCreateParams;


            // Reads DIDIT_API_KEY.

            Didit client = new Didit();


            var result =
            client.lists().entries().create("11111111-2222-3333-4444-555555555555",
            ListsEntriesCreateParams.builder()
                    .value("+14155552671")
                    .comment("Reported fraud")
                    .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->lists->entries->create('11111111-2222-3333-4444-555555555555',
            [
                'value' => '+14155552671',
                'comment' => 'Reported fraud',
            ]);

            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

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

            result = didit.lists.entries.create(
              "11111111-2222-3333-4444-555555555555",
              value: "+14155552671",
              comment: "Reported fraud"
            )
            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.Lists.Entries.CreateAsync("11111111-2222-3333-4444-555555555555",
            new ListsEntriesCreateParams

            {
                Value = "+14155552671",
                Comment = "Reported fraud",
            });

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    ComplianceListEntry:
      type: object
      description: Одно значение в списке.
      required:
        - uuid
        - value
        - display_label
        - comment
        - added_by
        - reference_session_id
        - reference_session_number
        - reference_session_type
        - reference_object_uuid
        - metadata
        - created_at
      properties:
        uuid:
          type: string
          format: uuid
          description: >-
            Идентификатор записи. Используйте его в качестве `entry_uuid` в
            запросе «Удалить запись списка».
        value:
          type: string
          description: >-
            Значение из списка: номер телефона в формате E.164, адрес
            электронной почты, номер документа, IP-адрес или диапазон CIDR,
            цифровой отпечаток устройства, адрес кошелька, банковский счёт,
            трёхбуквенный код страны по стандарту ISO 3166-1 alpha-3,
            `vendor_data`, любая строка в списке типа `key` или UUID
            сохранённого лица в списке лиц. Отправляемые вами значения
            сохраняются в нижнем регистре, за исключением номеров телефонов и
            кодов стран. Сопоставление нечувствительно к регистру.
        display_label:
          type: string
          nullable: true
          maxLength: 512
          description: >-
            Понятная метка. Didit заполняет её для записей, взятых из сессии
            (например, имя владельца и номер документа), если вы ничего не
            передали.
        comment:
          type: string
          description: >-
            Примечание в виде произвольного текста. Пустая строка, если не
            задано.
        added_by:
          type: string
          nullable: true
          description: >-
            Кто добавил запись: `api` (API-ключ), адрес электронной почты
            пользователя консоли или `console`, `system` или `migration`
            (записи, созданные Didit), либо `rule` (действие правила транзакций
            или мониторинга).
        reference_session_id:
          type: string
          format: uuid
          nullable: true
          description: >-
            Сессия верификации, из которой была взята запись. `null`, если
            запись была добавлена по значению.
        reference_session_number:
          type: integer
          nullable: true
          description: >-
            Номер этой сессии в рамках приложения, как он отображается в
            консоли.
        reference_session_type:
          type: string
          nullable: true
          enum:
            - kyc
            - kyb
            - null
          description: >-
            `kyc` для сессии проверки физического лица, `kyb` для сессии
            верификации бизнеса, `null`, если сессия отсутствует.
        reference_object_uuid:
          type: string
          format: uuid
          nullable: true
          description: >-
            Запись, которой соответствует элемент: запись лица, документа,
            телефона или адреса электронной почты, считанная из сессии, лицо,
            созданное с помощью «Загрузить лицо в список», или переданный вами
            UUID (например, UUID транзакции или `didit_internal_id`
            пользователя).
        metadata:
          type: object
          nullable: true
          additionalProperties: true
          description: >-
            Дополнительный контекст. Содержит ключи, установленные Didit
            (перечисленные здесь), объединенные с любыми `metadata`, переданными
            вами при создании записи, и возвращается в сохраненном виде. `null`,
            если контекст отсутствует.
          properties:
            reference_image_url:
              type: string
              description: >-
                Записи лиц: короткоживущий подписанный URL, генерируемый заново
                при каждом вызове; `null` для API-ключа с ограниченными правами
                без `media: read`. Отсутствует, если к записи не привязано
                изображение.
            front_image_url:
              type: string
              description: >-
                Записи документов, содержащие изображение лицевой стороны
                документа: временный подписанный URL, генерируемый заново при
                каждом вызове; `null` для API-ключа с ограниченной областью
                действия без `media: read`.
            full_name:
              type: string
              description: 'Записи документов, полученные из сессии: полное имя владельца.'
            issuing_state:
              type: string
              description: >-
                Записи документов, полученные из сессии: страна выдачи по
                стандарту ISO 3166-1 alpha-3.
            document_type:
              type: string
              description: >-
                Записи документов, полученные из сессии: код типа документа,
                например `P`, `ID` или `DL`.
            region:
              type: string
              description: >-
                Записи документов, полученные из сессии: штат или провинция
                выдачи для документа регионального выпуска, пусто, если
                неприменимо. Не задаётся действием добавления элементов сессии в
                список блокировки.
            document_number:
              type: string
              description: 'Записи документов, полученные из сессии: номер документа.'
            face_image_source:
              type: string
              enum:
                - front_image_camera_front
                - back_image_camera_front
              description: >-
                Записи лиц, полученные из селфи с захвата документа: какое
                именно селфи. Отсутствует для лиц из проверки живости.
            reference_node_id:
              type: string
              nullable: true
              description: >-
                Записи лиц, полученные из селфи с захвата документа: узел
                верификации личности, из которого поступило селфи.
            fingerprint_tier:
              type: string
              nullable: true
              enum:
                - persistent_id
                - composite_hash
                - legacy_fp
                - unknown
                - null
              description: >-
                Записи цифрового отпечатка устройства, полученные из сессии:
                способ формирования отпечатка. `persistent_id` идентифицирует
                одно устройство; `composite_hash` и `legacy_fp` могут быть
                общими для устройств одной модели.
            sandbox:
              type: boolean
              description: >-
                `true` для записи лица, загруженной в приложении песочницы;
                такая запись ни с чем не совпадает.
            reference_type:
              type: string
              enum:
                - transaction
                - vendor_user
                - vendor_business
              description: >-
                Задаётся вами: объект, на который указывает
                `reference_object_uuid`, чтобы консоль ссылалась на него.
            reference_id:
              type: string
              description: 'Задаётся вами: идентификатор исходной записи.'
        created_at:
          type: string
          format: date-time
          description: Когда запись была добавлена.
  responses:
    RateLimitedWrite:
      description: >-
        Превышен общий лимит на запись в 300 запросов в минуту на один API-ключ.
        Подождите время, указанное в `Retry-After`, перед повторной попыткой.
      content:
        application/json:
          schema:
            type: object
            required:
              - detail
            properties:
              detail:
                type: string
          example:
            detail: >-
              Write request rate limit exceeded. You can make up to 300 requests
              per minute.
  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.