Метод верификации данных¶

Метод /api/v1/verification/data предназначен для отправки зашифрованных паспортных данных на проверку. После отправки данные сохраняются в базе данных платформы и проходят проверку на корректность.

URL и Метод¶

URL:

POST https://verify.promotivation.ru/api/v1/verification/data/

HTTP метод:
POST

Заголовки запроса¶

Authorization: Bearer {токен}
Content-Type: application/json

Тело запроса¶

Тело запроса должно быть представлено в формате JSON. Все данные, включая зашифрованные поля, изображения (в base64) и симметричный ключ (secret), передаются в теле запроса.

Пример тела запроса¶

{
  "name": "Иван",
  "patronymic": "Иванович",
  "surname": "Иванов",
  "birthdate": "01.01.1991",
  "inn": "123456789012",
  "series": "1234",
  "number": "123456",
  "issueDate": "20.01.2011",
  "issuedWhom": "УФМС России по НСО",
  "registrationAddress": "г. Новосибирск, ул. Советская, д.15, кв.15",
  "file1": "base64_кодированное_изображение",
  "file2": "base64_кодированное_изображение",  // опционально
  "consent": true,
  "secret": "зашифрованный_симметричный_ключ"
}

Описание параметров¶

Параметр	Тип	Описание	Обязательный
name	string	Имя, как указано в паспорте.	Да
patronymic	string	Отчество, как указано в паспорте.	Да
surname	string	Фамилия, как указана в паспорте.	Да
birthdate	string	Дата рождения в формате `ДД.ММ.ГГГГ`.	Да
inn	string	ИНН (12 цифр).	Да
series	string	Серия паспорта (4 цифры).	Да
number	string	Номер паспорта (6 цифр).	Да
issueDate	string	Дата выдачи паспорта в формате `ДД.ММ.ГГГГ`.	Да
issuedWhom	string	Орган, выдавший паспорт.	Да
registrationAddress	string	Адрес регистрации, как указан в паспорте.	Да
file1	string	Основное изображение паспорта (форматы: .png, .jpeg, .jpg, .gif, .pdf, .webp, .heic; размер не более 10 МБ).	Да
file2	string	Дополнительное изображение паспорта (аналогичные форматы и ограничения).	Нет
consent	boolean	Согласие на обработку персональных данных. Значение должно быть `true`.	Да
secret	string	Зашифрованный симметричный ключ, полученный шифрованием (AES-128-CBC) с последующим шифрованием ключа RSA и кодированием в base64.	Да

Ответ¶

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

При успешной отправке данных сервер возвращает следующий ответ:

{
  "status": "OK",
  "idPerson": "уникальный_id_верифицируемого"
}

Возможные коды ответа¶

200 OK
Данные успешно отправлены и сохранены.
status: OK
idPerson: Уникальный идентификатор верифицируемого
400 Bad Request
Неверные или некорректные поля.
status: INVALID_FIELDS
message: "The fields are uncorrected: {name}, {surname}, ..." (перечень некорректных полей)
401 Unauthenticated
Неверный токен аутентификации.
403 Forbidden
Доступ запрещён (например, если учётная запись партнёра заблокирована).

Примечания¶

Перед отправкой данных необходимо выполнить их шифрование:
Данные шифруются симметричным алгоритмом (AES-128-CBC).
Симметричный ключ шифруется с использованием RSA и кодируется в base64, после чего передаётся в параметре secret.
Все передаваемые данные должны точно соответствовать тем, что указаны в паспорте.
Изображения должны быть предварительно преобразованы в base64.
При получении ошибки с кодом 400 Bad Request поле message может содержать перечень некорректных полей.