Перейти к основному содержанию
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 МБ перед обработкой, поэтому сверхвысокое разрешение не повышает точность.

ref_image
file
обязательно

Эталонное изображение лица для сравнения (например, фото из удостоверения личности или ранее зарегистрированная фотография). Те же ограничения по формату и размеру, что и для user_image.

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

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

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

50

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

Когда true, сервис поворачивает входные изображения с шагом 90 градусов (0, 90, 180, 270) и использует ориентацию, обеспечивающую наилучшее обнаружение лица — полезно для мобильных снимков с отсутствующей ориентацией EXIF. Увеличивает задержку, поэтому включайте только в том случае, если вы не можете гарантировать правильную ориентацию изображений.

Пример:

false

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

Если true (по умолчанию), сохраняет вызов как сессию типа API — видимую в Business Console, доступную через GET /v3/session/{sessionId}/decision/ по возвращенному request_id и с уведомлением через webhook status.updated. Если false, ничего не сохраняется, а request_id является временным UUID только для сопоставления ответа.

Пример:

true

vendor_data
string

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

Пример:

"user-123"

metadata
object

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

Пример:

Ответ

Сравнение лиц вычислено. face_match.score представляет собой число с плавающей точкой от 0 до 100 (два знака после запятой); status имеет значение Approved, если оценка строго выше face_match_score_decline_threshold, иначе Declined с поясняющим предупреждением. При низкой схожести или невозможности оценить пару все равно возвращается 200: проверяйте face_match.status и face_match.warnings, а не только HTTP-код. Если save_api_request=true, request_id является сохраненным id сессии.

request_id
string<uuid>

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

face_match
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 г.