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

Авторизации

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.

Тело

multipart/form-data
user_image
file
обязательно

Фронтальное изображение лица (например, селфи). Допустимые расширения: tiff, jpg, jpeg, png, webp. Максимальный размер загружаемого файла: 5 MB (файлы большего размера отклоняются с ошибкой 400). Перед обработкой изображения автоматически сжимаются примерно до 0.5 MB, поэтому сверхвысокое разрешение не повышает точность. На изображении должен быть только один человек — если лиц несколько, оценивается самое крупное и добавляется предупреждение MULTIPLE_FACES_DETECTED.

face_liveness_score_decline_threshold
number<float>
по умолчанию:30

Порог оценки проверки живости (0–100). Вычисленная оценка на уровне или ниже этого значения генерирует предупреждение LOW_LIVENESS_SCORE и устанавливает status в Declined. По умолчанию 30; увеличьте его для более строгой защиты от спуфинга. Значения вне диапазона 0–100 возвращают 400.

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

30

rotate_image
boolean
по умолчанию:false

Когда true, сервис пробует поворачивать входное изображение с шагом 90 градусов и использует ориентацию, обеспечивающую наилучшее обнаружение лица. Полезно, когда отсутствуют данные ориентации EXIF. Увеличивает задержку ответа.

Пример:

false

save_api_request
boolean
по умолчанию:true

Когда true (по умолчанию), сохраняет вызов как сессию типа API, сохраняет изображения лица, отправляет webhook status.updated и регистрирует обнаруженное лицо в вашем индексе Поиска по лицу. Когда false, вызов является однократным — ничего не сохраняется, а лицо не регистрируется. Проверки по списку блокировки и на дубликаты выполняются в обоих случаях.

Пример:

true

vendor_data
string

Необязательный непрозрачный идентификатор (ваш идентификатор пользователя, email, UUID…), сохраняемый в сессии и возвращаемый обратно. Также используется для исключения предыдущих сессий с тем же vendor_data из проверки на дубликаты лиц, благодаря чему повторная верификация того же пользователя не вызывает ошибку DUPLICATED_FACE.

Пример:

"user-123"

metadata
object

Необязательный объект JSON, сохраняемый вместе с сессией (когда save_api_request=true) и возвращаемый обратно. В multipart-запросах отправляйте его как строковое поле в формате JSON — он парсится в объект.

Пример:

Ответ

Пассивная проверка живости завершена. liveness.score представляет собой оценку уверенности модели от 0 до 100 в том, что на изображении живой человек; status имеет значение Approved, если не сработало предупреждение уровня error. Лицо с признаками спуфинга или из списка блокировки всё равно возвращает 200: проверяйте liveness.status и liveness.warnings, а не только HTTP-код. Если save_api_request=true, request_id является сохранённым идентификатором сессии.

request_id
string<uuid>

Идентификатор сохраненной сессии при save_api_request=true (доступен для использования с GET /v3/session/{sessionId}/decision/); в противном случае это временный корреляционный UUID.

liveness
object
vendor_data
string | null

Эхо-значение переданного вами vendor_data или null.

metadata
object | null

Эхо-значение переданного вами объекта metadata или null.

created_at
string<date-time>

Временная метка ISO 8601 (UTC) момента генерации ответа, например 2026-06-12T01:04:42.763237+00:00.

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