Сценарии использования
Регистрация и авторизация через API доступны только при отключенном LRS. Если вы хотите использовать LRS, вам нужно воспользоваться Web-компонентой.
Для регистрации и авторизации пользователей через BAF потребуется создать аппликанта — объект, в котором будут храниться данные о пользователе (имя, фамилия, контактные данные и т.д.), количество попыток верификации и ее текущий статус, а также другие сопутствующие верификации данные.
Чтобы создать аппликанта, войдите в BAF API, авторизуйтесь и воспользуйтесь эндпоинтом POST /api/v2/private/Applicants.
После создания аппликанта можно отправлять запросы на регистрацию и авторизацию через API.
Результаты регистрации и авторизации можно просмотреть в BAF Dashboard, который доступен по адресу http://<baf_domain>. Логин и пароль от BAF Dashboard указаны в поле baf-user-sercet
файла ./cfg/baf.secrets.json.
Указанные сценарии можно также реализовать через веб-интерфейс заказчика после встраивания Web-компоненты.
Для одного аппликанта можно выбрать только один из способов регистрации, указанных ниже.
Регистрация пользователя по селфи
Создайте запрос на верификацию через эндпоинт POST /api/v2/public/Validation.
Загрузите изображение лица пользователя.
Укажите documentType: 10 (регистрация/авторизация по лицу).
Укажите applicantId.
Пример запроса:
{
"model": {
"faceImageBase64": "вставьте изображение лица в base64",
"documentType": 10
},
"applicantId": "укажите applicantId"
}
- Просмотрите данные о процессе регистрации в BAF Dashboard.
Регистрация пользователя по селфи и документу с проверкой соответствия лица на селфи лицу на документе
Создайте запрос на верификацию через эндпоинт POST /api/v2/public/Validation.
Загрузите изображение документа пользователя в base64.
Загрузите изображение лица пользователя в base64.
Укажите тип предоставляемого документа.
Укажите applicantId.
Пример запроса:
{
"model": {
"faceImageBase64": "вставьте изображение лица в base64",
"frontImageBase64": "вставьте изображение документа в base64",
"documentType": 2
},
"applicantId": "укажите applicantId"
}
- Просмотрите данные о процессе регистрации в BAF Dashboard.
Авторизация пользователя
Создайте запрос на верификацию через эндпоинт POST /api/v2/public/Validation.
Загрузите изображение лица пользователя.
Укажите documentType: 10 (регистрация/авторизация по лицу).
Укажите applicantId.
Пример запроса:
{
"model": {
"faceImageBase64": "вставьте изображение лица в base64",
"documentType": 10
},
"applicantId": "укажите applicantId"
}
- Просмотрите данные о процессе авторизации в BAF Dashboard.