Перейти к основному содержанию
GET
curl

Фильтр по типу сессии

Используйте параметр запроса session_kind, чтобы выбрать тип сессий для возврата: Каждая строка ответа содержит session_kind: "user" | "business", чтобы ваш клиент мог определять структуру каждой строки.

Общие фильтры

Эти фильтры применяются к обоим типам (фильтры только для пользователей игнорируются, когда session_kind=business, и наоборот):

Примеры

Ответ (сокращён):

Структура строк зависит от типа

Строки Проверки пользователей (KYC) включают: portrait_image, document_type, full_name, country (страна выдачи), phone_number, email_address и несколько полей проверки: assignee (проверяющий в Консоли, который ведёт сессию, или null), waiting_since и sla_due_at (задаются только пока сессия находится в статусе In Review), top_warnings (наиболее важные предупреждения, каждое с risk, feature, log_type и short_description) и warnings_count. Строки Верификации бизнеса (KYB) включают: workflow_type, workflow_label, company_name, registration_number, country (страна регистрации). Оба типа содержат: session_id, session_kind, session_number, status, vendor_data, created_at. Полную матрицу функций см. в разделе Обзор сессий.

Пагинация

Пагинация использует limit (по умолчанию 50) и offset (по умолчанию 0), а в ответе есть абсолютные URL next и previous. Оба параметра принимают значения до 1000000; большее значение возвращает 400. count точен до 100 и остаётся равным 100 при большем количестве, поэтому не используйте его как общее число. Продолжайте запрашивать URL next, пока он не станет null. При session_kind=all значение count равно сумме обоих типов, каждый из которых ограничен 100.

Связанные материалы

Авторизации

x-api-key
string
header
обязательно

API-ключ вашего приложения из раздела «Разработчикам» -> «API-ключи» в Business Console. Основной ключ имеет полный доступ. Именованный ключ может иметь ограниченную область действия: без доступа, чтение или запись для каждого ресурса, ограничение определенными сценариями или одобренными сессиями, списком IP-адресов и сроком действия. 401 означает, что ключ неверен, отозван или его срок действия истек; 403 означает, что ключ не был передан, у ключа нет доступа к этому ресурсу или действию, либо запрос поступил с адреса вне его списка IP-адресов; 404 на маршруте сессии означает, что сессия не входит в сценарии или статусы ключа. Ключ без доступа к медиа получает URL изображений, видео и PDF как null, а ключ без прав на запись сессий получает ссылки на сессии и токены как null. См. https://docs.didit.me/console/api-keys.

Параметры запроса

session_kind
enum<string>
по умолчанию:user

Какой тип сессий возвращать в списке: user (только KYC, по умолчанию), business (только KYB) или all (оба типа, объединённые - семантику объединённой пагинации см. в описании). Сопоставление нечувствительно к регистру (работает BUSINESS); любое значение, отличное от вариантов регистра user/business/all, возвращает 400.

Доступные опции:
user,
business,
all
limit
integer
по умолчанию:50

Максимальное количество строк на странице (для каждого типа при session_kind=all). По умолчанию 50.

Требуемый диапазон: 1 <= x <= 1000000
offset
integer
по умолчанию:0

Количество строк, пропускаемых перед первой возвращаемой строкой. По умолчанию 0. Рекомендуется переходить по URL next/previous из ответа.

Требуемый диапазон: 0 <= x <= 1000000
status
string

Разделённый запятыми список статусов сессий для включения, например Approved,In Review. Значения чувствительны к регистру; см. Статусы верификации. Неизвестные значения не дают совпадений.

vendor_data
string

Фильтр по точному совпадению с vendor_data, переданным при создании сессии (ваш собственный идентификатор пользователя/компании). Для частичных совпадений используйте search.

Полная отображаемая ссылка, например S-0001 (пользователь) или B-0001 (компания), соответствует только сессии с этим номером и типом; ведущие нули и регистр букв не влияют на сопоставление. Интеллектуальный поиск по свободному тексту. Полный UUID сопоставляется с session_id; числовой ввод сопоставляется с префиксом номера сессии, номерами документов/персональными номерами, префиксом телефона или vendor_data; ввод, содержащий @, сопоставляется с префиксами email; прочий текст сопоставляется с именами (без учёта диакритики) и vendor_data. Свободный текст, содержащий цифры, дополнительно сопоставляется с полями поиска документов/персональных номеров и префиксами номеров сессий.

workflow_id
string

Разделённые запятыми UUID сценариев (их можно найти на странице Workflows в Console). Некорректные UUID в списке игнорируются; если валидных нет, результат будет пустым.

date_from
string<date>

Только сессии, созданные в эту дату (UTC) или позже, формат YYYY-MM-DD. Некорректный формат даты возвращает ошибку 400.

date_to
string<date>

Только сессии, созданные до этой даты (UTC) включительно, формат YYYY-MM-DD. Для строк KYC включается весь день; для строк KYB сравнение выполняется как created_at <= date_to (полночь), поэтому используйте дату следующего дня, чтобы включить полный день сессий KYB.

tags
string

Разделённый запятыми список идентификаторов тегов (tags вашего приложения). Возвращает сессии, содержащие любой из них. Идентификаторы, не являющиеся корректными UUID, игнорируются, и если ни один из них не валиден, список будет пустым.

decided_from
string<date-time>

Дата и время в формате ISO 8601. Возвращает сессии, статус которых в последний раз изменился в этот момент или позже. Фильтрация выполняется по времени последнего изменения статуса, а не по времени создания.

decided_to
string<date-time>

Дата и время в формате ISO 8601. Возвращает сессии, статус которых в последний раз изменился до этого момента. Объедините с decided_from для задания полуинтервала.

country
string

Разделённый запятыми фильтр по странам. Для строк KYC: трёхбуквенные коды ISO 3166-1 alpha-3 страны выдачи документа, удостоверяющего личность (например, ESP,USA), которая может отличаться от гражданства. Для строк KYB: код страны компании из реестра.

document_type
string

Разделённые запятыми коды типов документов, удостоверяющих личность, проверенных в сессии (только строки KYC): P (Паспорт), ID (Удостоверение личности), DL (Водительское удостоверение), RP (Вид на жительство), SSC (Карта социального страхования), HIC (Медицинская страховая карта), WP (Разрешение на работу), TC (Налоговая карта), VISA, PSC (Карта государственного обслуживания), BC (Свидетельство о рождении), OTHER. Обратите внимание, что поле ответа document_type содержит отображаемое имя, а не код.

document_name
string

Точные названия документов; несколько названий можно передать через запятую, однако разделение по запятым выполняется только при наличии более одного разделителя - (отдельное название со встроенной запятой сопоставляется целиком). Названия указываются так, как они распознаются при верификации документов (лицевая или оборотная сторона), например Spain - Id Card (2021). Только для строк KYC.

region
string

Разделённые запятыми значения региона/штата документа (для документов, выдаваемых по регионам, таких как водительские удостоверения в США). Только для строк KYC.

didit_internal_id
string<uuid>

Фильтр по внутреннему идентификатору пользователя в Didit (поле ответа didit_internal_id) для вывода всех сессий одного верифицированного пользователя. Должен быть корректным UUID; некорректные значения возвращают 400. Только для записей KYC.

session_type
string

Разделённый запятыми список каналов создания сессий: API, HOSTED, MIGRATED. Специальное значение ALL (или отсутствие параметра) отключает фильтр. Только строки KYC.

api_service
enum<string>

Фильтр автономных сессий API по сервису. Недопустимые значения возвращают 400. Только строки KYC.

Доступные опции:
ID_VERIFICATION,
FACE_MATCH,
AGE_ESTIMATION,
FACE_SEARCH,
POA,
AML,
KYB_REGISTRY,
PASSIVE_LIVENESS,
DATABASE_VALIDATION,
PHONE_VERIFICATION,
EMAIL_VERIFICATION
screened_full_name
string

Поиск по имени без учёта диакритических знаков среди данных, проверенных в рамках AML и проверки по базам данных. В сочетании с api_service=AML или api_service=DATABASE_VALIDATION поиск ограничивается проверенными данными соответствующей функции. Только строки KYC.

warning
string

Разделённые запятыми коды риска предупреждений; возвращает сессии, для которых сработал любой из них (например, POSSIBLE_FRAUD). Коды риска перечислены для каждой функции в документации по предупреждениям. Применяется к строкам KYC и, с кодами предупреждений для бизнеса, к строкам KYB.

status_initialized_as_in_review
boolean

Когда true, возвращает только сессии, решение по которым изначально перешло в статус In Review (полезно для аудита объема ручных проверок). Только строки KYC.

is_kyc_to_be_reviewed
boolean

true возвращает сессии, верификация документов которых помечена для ручной проверки; false возвращает сессии, где верификация документов явно не помечена. Опустите, чтобы отключить фильтр. Только для строк KYC.

euuid
string<uuid>

Фильтр по euuid конечного пользователя (UUID, назначенный верифицируемому пользователю; используется диплинками Console). Должен быть валидным UUID; некорректные значения возвращают ошибку поля с кодом 400. Только строки KYC.

organization_name
string

Разделённый запятыми список названий организаций. Предназначен для Console; при использовании API-ключа (уже привязанного к одному приложению) соответствует только названию вашей собственной организации.

Ответ

Список сессий с пагинацией. Элементы results представляют собой строки KYC, строки KYB или и то, и другое в зависимости от session_kind; различайте их с помощью поля session_kind каждой строки.

count
integer
обязательно

Количество сессий, соответствующих фильтрам: точное значение до 100 и с ограничением 100 сверх этого порога, поэтому не используйте его в качестве общего итога. Используйте next, чтобы узнать, есть ли ещё страницы. Для session_kind=all это сумма обоих типов, каждый с ограничением 100.

Пример:

2

next
string<uri> | null
обязательно

Абсолютный URL следующей страницы или null на последней странице.

Пример:

"https://verification.didit.me/v3/sessions/?limit=20&offset=20"

previous
string<uri> | null
обязательно

Абсолютный URL предыдущей страницы или null на первой странице.

Пример:

null

results
(KYC session row (session_kind: user) · object | KYB session row (session_kind: business) · object)[]
обязательно

Строки сессий, сначала новые. При session_kind=all сначала идут строки KYC, затем строки KYB.

Сводная строка для сессии Проверки пользователей (KYC). Поля личности (full_name, country, document_type, portrait_image, контактные поля) заполняются по мере прохождения пользователем шагов верификации и имеют значение null, пока соответствующий шаг не завершён. Поля, ограниченные настройкой атрибутов ответа сценария, также возвращаются как null.

Последнее изменение 7 ноября 2026 г.