Метод проверки статуса верификации¶
Метод /api/v1/verification/status/{idPerson} предназначен для получения текущего статуса проверки паспортных данных (ПД) по уникальному идентификатору верифицируемого.
URL и Метод¶
URL:
GET https://verify.promotivation.ru/api/v1/verification/status/{idPerson}
HTTP метод:
GET
Заголовки запроса¶
Authorization: Bearer {токен}
Параметры запроса¶
| Параметр | Тип | Описание | Обязательный |
|---|---|---|---|
| idPerson | string | Уникальный идентификатор верифицируемого | Да |
Тело запроса¶
Тело запроса отсутствует. Единственный обязательный параметр передаётся в URL.
Пример успешного ответа¶
При успешном выполнении запроса сервер возвращает JSON-объект с полями status и message:
{
"status": 1,
"message": "Data verified"
}
Возможные статусы верификации¶
Значение поля status |
Пример значения поля message |
Описание |
|---|---|---|
| 1 | Data verified | Данные успешно верифицированы. |
| 2 | Data for verification | Данные находятся на верификации. |
| 3 | Denied. The second page is missing. | Отказано. Отсутствует вторая страница паспорта. |
| 4 | Denied. The image is unreadable. | Отказано. Изображение паспорта не читаемо. |
| 5 | Denied. The data does not match the image: {name}, {patronymic}, {surname}, {birthdate}, {inn}, {series}, {number}, {issueDate}, {issuedWhom}, {registrationAddress} | Отказано. Данные не совпадают с изображением (указаны некорректные поля). |
| 6 | Denied. INN not found | Отказано. ИНН не найден в налоговой службе. |
| 7 | Data is waiting for action | Данные находятся на верификации. |
| 8 | Data requires update | Данные неактуальны – требуется обновление |
Коды ответа сервера¶
-
200 OK
Запрос выполнен успешно, возвращены данные верификации. -
*401 Unauthenticated
Неверный токен аутентификации. -
403 Forbidden
Доступ запрещён (например, если учётная запись партнёра заблокирована).
Примечания¶
- Убедитесь, что в URL передан корректный
idPerson. - Ответ содержит числовое значение поля
statusи текстовое описание в полеmessage, которое может включать динамически сформированный перечень некорректных полей (при статусе 5). - Для корректного получения статуса запрос обязательно должен содержать валидный JWT-токен в заголовке
Authorization.