Skip to content

Функция сравнения лиц на фото

comparePhotos

Тип HTTP запроса: multipart POST

URL вызова: https://api.id-x.org/idx/api2/comparePhotos

Параметры:

Параметр Тип Обязательный Описание
accessKey String Да Ключ доступа, выданный при регистрации в Системе IDX
secretKey String Да Секретный ключ, выданный при регистрации в Системе IDX
photo1 File Да Фото с первым лицом
photo2 File Да Фото со вторым лицом

Проверка распознает следующие форматы: JPG, JPEG, PNG

Рекомендуемый размер фотографий 1024x768 размером до 2 Мб

Функция возвращает:

Параметр Тип Обязательный Описание
resultCode Int Да Результат выполнения функции (0 – успешное завершение функции, отличное от 0 значение – ошибка выполнения)
resultMessage String Нет Сообщение об ошибке
operationToken String Нет Уникальный идентификатор операции
startMoment String Нет Время начала обработки документа, формат «ДД.ММ.ГГГГ ЧЧ:ММ:СС»
stopMoment String Нет Время окончания обработки документа, формат «ДД.ММ.ГГГГ ЧЧ:ММ:СС»
state String Нет Статус выполнения операции. Подробнее см. статус выполнения операции
faces Faces Нет Объект, содержащий результат сравнения лиц на фотографиях. Подробнее см. объект Faces

Пример вызова:

POST /idx/api2/comparePhotos
Host: api.id-x.org
Content-Type: multipart/form-data; boundary=----
Accept: application/json

------
Content-Disposition: form-data; name="accessKey"

Выданный accessKey
------
Content-Disposition: form-data; name="secretKey"

Выданный secretKey
------
Content-Disposition: form-data; name="photo1"; filename="file1.jpg"
Content-Type: image/jpeg

[File data]
------
Content-Disposition: form-data; name="photo2"; filename="file2.png"
Content-Type: image/png

[File data]
------

Пример успешного ответа:

{
    "resultCode": 0,
    "operationToken": "8a8ec94ab432b83462330a0e8a2ade6bc",
    "state": "COMPLETE",
    "startMoment": "29.11.2017 16:07:24",
    "stopMoment": "29.11.2017 16:17:41",
    "faces": {*объект Faces*}
}

Пример неуспешного ответа:

{
    "resultCode": 0,
    "operationToken": "8a8ec94ab432b83462330a0e8a2ade6bc",
    "state": "COMPLETE",
    "startMoment": "29.11.2017 16:07:24",
    "stopMoment": "29.11.2017 16:17:41",
    "faces": {
                "equal": false,
                "similarity": 0.21321
    }
}

Объект Faces

Данный объект описывает результаты сравнения лиц на фотографиях, его поля:

Атрибут Тип Описание
equal Boolean Результат сравнения лиц (TRUE, если лица совпадают, FALSE, если лица не совпадают)
similarity Float Вероятность совпадения лиц

Пример объекта Faces в формате json:

 {
      "equal": true,
      "similarity": 0.98481
 }