Метод изменения верификации¶
Метод /api/v1/verification/change/{idPerson} предназначен для обработки запросов на изменение паспортных данных (ПД) в уже созданной верификации. С его помощью можно обновить информацию о верифицируемом лице.
URL и Метод¶
URL:
PATCH https://verify.promotivation.ru/api/v1/verification/change/{idPerson}
HTTP метод:
PATCH
Заголовки запроса¶
Authorization: Bearer {токен}Content-Type: application/json
Тело запроса¶
Тело запроса должно быть представлено в формате JSON и содержать следующие поля:
Пример тела запроса¶
{
"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_кодированное_изображение", // опционально
"file3": "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 | Основное изображение паспорта в формате base64 (форматы: .png, .jpeg, .jpg, .gif, .pdf, .webp, .heic; размер не более 10 МБ). | Да |
| file2 | string | Дополнительное изображение паспорта в формате base64 (аналогичные форматы и ограничения). | Нет |
| file3 | string | Дополнительное изображение подтверждающее ИНН base64 (аналогичные форматы и ограничения). | Нет |
| consent | boolean | Согласие на обработку персональных данных. Значение должно быть true. |
Да |
| secret | string | Зашифрованный симметричный ключ, полученный шифрованием (AES-128-CBC) с последующим шифрованием ключа RSA и кодированием в base64. | Да |
Ответ¶
При успешном изменении данных сервер возвращает следующий ответ:
Пример успешного ответа¶
{
"status": "OK",
"idPerson": "dgh38hwh398rhfujsfd98bwefibukj"
}
Коды ответа сервера¶
- 200 OK
Данные успешно обновлены. - status:
OK -
idPerson: Уникальный идентификатор верифицируемого.
-
400 Bad Request
Неверные или некорректные поля запроса. - status:
INVALID_FIELDS -
message: "The fields are uncorrected: {name}, {surname}, ..." (перечень некорректных полей).
-
401 Unauthenticated
Неверный токен аутентификации. -
403 Forbidden
Доступ запрещён (например, если учётная запись партнёра заблокирована). -
NOT_PERSON
Верифицируемый с указаннымidPersonне найден.
Примечания¶
- Перед отправкой запроса убедитесь, что все поля заполнены корректно и данные соответствуют информации, указанной в паспорте.
- Изображения должны быть предварительно преобразованы в base64 и соответствовать требуемым форматам.
- Полученный
secretдолжен быть зашифрован симметричным ключом и дополнительно защищён RSA шифрованием.