Биометрическая аутентификация по эталонной фото, полученной от ИС партнера

Биометрическая аутентификация по эталонной фото из ИС партнера это биометрическая аутентификация, которая осуществляется в результате сравнения лучшего кадра, полученного при определении живости лица, с фото лица, полученной от ИС партнера.

Основные этапы биометрической аутентификации по эталонной фото лица, полученной от ИС партнера в CID:

1) ИС партнера запрашивает токен по логину и паролю, предоставленному CID

2) ИС партнера производит старт сессии в CID по полученному токену

3) СID стартует сессию и отображает экран биометрической аутентификации

4) Пользователь осуществляет сканирования лица клиента и CID проводит определение живости лица и выделение лучшего кадра

5) CID проводит сверку фото лица полученного из запроса ИС партнера с фото лица полученного при сканировании в CID, завершает сессию и передает номер сессии в ИС партнера на указанный URI

9) ИС - партнера по номеру сессии получает данные сессии ( результаты биометрической аутентификации)

Токен, получаемый ИС партнера для сессии - одноразовый. Период жизизни токена состовляет 15 минут

Методы взаимодействия

Получение токена

Запрос

curl --location 'http://cid.supreme-team.tech/api/v1/customer-identification/session-token?identificationType=REFERENCE_DATA&redirectUri=https%3A%2F%2Foidcdebugger.com%2Fdebug&state=someState' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Y2lkLWNsaWVudDpwYXNzd29yZA==' \
--data '{
    "referenceData": {
       "identificationNumberType": "INTERNATIONAL_PASSPORT_NUMBER",
       "identificationNumber": "AB00567890",
       "countryCode": "FRA",
       "portrait": "base64_image"
    }
}'

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

Заголовок

Параметр	Значение	Обязательный	Коментарий
identificationType	REFERENCE_DATA	Да	Указатель на запуск сессии биометрической аутентификации по эталонному изображению лица, переданному из ИС партнера
redirectUri	Указывается в ИС Партнера	Да	ИС Партнера передает ссылку на ресурс, куда CID вернет данные сессии. Ограничения - указанная ссылка на ресурс должна быть в списке разрешенных. Партнер за ранее должен предоставить BTSD список uri для включения в список разрешенных
state	Указывается в ИС Партнера	Нет	Состояние системы Партнера которое будет передано CID в редиректе на ресурс ИС партнера в неизменном состоянии. Длина параметра должна быть не более 500 символов

Тело запроса

identificationNumberType	String	Да	Тип идентификационного пераметра физического лица. Допустима передача следующего типа: IIN - типом идентификационного параметра является ИИН INTERNATIONAL_PASSPORT_NUMBER - идентификационным параметром является номер международного паспорта иностранца
identificationNumber	String	Да	Идентификационный параметр физического лица, передается номер ИИН или номер паспорта. Если передается ИИН то обязательно должно быть передано 12 цифр.
countryCode	String	Нет*	Код страны (ISO 3166-1 Alfa-3), выдавшей документ. *Параметр обязателен для передачи, если identificationNumberType = INTERNATIONAL_PASSPORT_NUMBER, Иначе не обязательный и не передается в CID, CID будет фиксировать код страны KAZ
portrait	base64	Да	Фото с изображением лица
confidenceLevel	String	Нет	Коэффициент схожести, определенный партнером. Указывается десятичная дробь. Допустимое значение должно входить в диапазон от 0,3 до 0,6 Если параметр не передан, то для процесса биометрической аутентификации берется значение confidenceLevel заданное по умолчанию и равное 0,4
allowFaceMatchFailure	Boolean	Нет	Признак низко-рисковой операции, если в параметре передано значение TRUE. При низко-рисковой операции в случае, если биометрическая аутентификация будет не пройдена клиентом, то ИС Партнера получит ответ в котором будут переданы параметры следующих объектов: document, liveness, errorInfo

Ответ

{
    "token": "eyJhbGciOiJIUzUxMiJ9.eyJzZXNzaW9uU2VjcmV0IjoiMjI3MmQyODAtZjA4Zi00M2VmLWJkODQtM2E0M2JkZDM1Mjc1IiwiZXhwIjoxNzQyOTgzNzg1fQ.oOptJPqKxv1LMUKfKnNevyx0hyYstjXiNIW2gbwpfAxoTxzoKd8FHYU2UYu-R79o4-1hbjIGNQUmRDW5X2DmQQ"
}

Старт сессии

https://cid.test.supreme-team.tech?token=$token

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

Параметр	Тип	Обязательный	Описание
token	String	Yes	Токен, полученный в методе получения токена

Получение данных сессии

Запрос

curl --location 'http://cid.test.supreme-team.tech/api/v1/customer-identification/6cd28065-a96e-40c0-91be-35da38610e1e/identification-result' \
--header 'Authorization: Basic Y2lkLWNsaWVudDpwYXNzd29yZA==' \
--data ''

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

Параметр	Тип	Обязательный	Описание
<идентификатор сессии>	String	Yes	Уникальный идентификатор сессии в CID
identification-result	String	Yes	Тип запрашиваемых данных. identification-result - вернуть результат сессии. В случае если сессия завершилась успешно, то ИС получит данные документа удостоверяющего личность и данные биометрической аутентификации. В случае если сессия завершилась успешно, то ИС получит данные ошибки

Ответ

Пример - сессия завершена успешно (пользователь прошел биометрическую аутентификацию)

{
    "sessionId": "58fc4416-291a-45d4-829b-f2dca4b34fb5",
    "sessionStarted": "2024-05-21T21:22:09.459957Z",
    "sessionEnd": "2024-05-21T21:23:16.48968Z",
    "sessionStatus": "SUCCESS",
    "document": null,
    "liveness": {
        "verificationType": "VERIFICATION_3D",
        "selfieConfidenceLevel": 0.91438,
        "creationTime": "2024-05-21T21:23:15.164436Z",
        "responseTime": "2024-05-21T21:23:16.48968Z"
    },
    "error": null
}

Пример - сессия завершена не успешно пользователь завершил сессию (пользователь не прошел биометрическую аутентификацию)

{
    "sessionId": "bc8f8267-0c1d-44d0-8473-927035688941",
    "sessionStarted": "2024-03-28T07:48:25.045395Z",
    "sessionEnd": "2024-03-28T07:50:52.255556Z",
    "sessionStatus": "FAILED",
    "document": null,
    "liveness": null,
    "errorInfo": {
        "eventType": "LIVENESS_FAILED",
        "error": "CID_9",
        "errorMessage": "The face in the photo and the face on the document did not match, start the whole process again"
    }
}

Структура ответа

Параметр	Тип	Обязательный	Описание
sessionId	String	Yes	Уникальный идентификатор сессии в CID
sessionStarted	DateTime	Yes	Дата/время начала сессии в CID
sessionEnd	DateTime	Yes	Дата/время окончания сессии в CID
liveness	Object	No	Данные биометрической аутентификации
verificationType	String	YES	Тип биометрической верификации примененной CID. VERIFICATION_3D - была применена 3D Liveness
selfieConfidenceLevel	String	YES	Полученный коэффициент схожести лиц при сравнении эталонной фото лица в CID с лучшим кадром из процесса определения витальности лица
creationTime	DateTime	YES	Дата создания медиа материалов (прохождение лайвнеса)
responseTime	DateTime	YES	Дата/время формирования ответа
errorInfo	Object	No	Данные об ошибке
eventType	String	Yes	Событие/этап на котором произошла ошибка
error	String	Yes	Код ошибки
errorMessage	String	Yes	Текст ошибки

Ошибки

Перечень ошибок см., статью Ошибки сервисов CID

Получение медиа-данных сессии

В рамках данной сессии в CID фиксируются следующие медиа-данные

• Лучший снимок с изображением лица;

• Видо-ролик определеия живости лица.

Описание методов получения медиа-данных см., статью Получение медиа-данных сессии