POST /documents/recognize

Метод позволяет получить реквизиты документа на основании его скана или фотографии.

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

Название Тип Формат Описание
documentType object DocumentType Тип документа, который распознается

DocumentType

Метод распознования поддерживает следующие документы:

Название Описание
passport Паспорт

Заголовки

Название Описание
Content-Type Тип контента
Authorization Заголовок авторизации

Content-Type

Допустимые значения Content-Type:

  • application/pdf;
  • image/png;
  • image/jpg;
  • image/jpeg;
  • image/tiff.

Тело запроса

В теле запроса описываются бинарные данные документа, реквизиты которого необходимо распознать.

Пример

  POST /realty/drive/v2/documents/recognize?documentType=passport
  Authorization: ReestroAuth auth.sid=717726209B543848879C33F2BDDAB9F8561EFAC465A5DC439193062C700FAFDA&portal.orgid=1269f58a-3d40-42e1-91ad-a4251566419c
  Content-Type: application/pdf
JVBERi0xLjMNCjEgMCBvYmoNClsvUERGIC9UZXh0IC9JbWFnZUIgL0ltYWdlQyAvSW1hZ2VJXQ0KZW5kb2JqDQo3IDAgb2JqDQo8PCAvTGVuZ3RoIDQwNjYgL0ZpbHRlciAvRmxhdGVEZWNvZGUgPj4gc3RyZWFtDQpYCb0cW44jt/E/gO/Qn7MJlss3m0BgBEkcw4BhwPYG+cjmQ6uRjCSeNTJYJ/FJcogcIZdLkc0ii+yHxJbGsLUatbpYT9aL1frkF/8Y5MiUttObG4wamRnV4Kxhyujh+TT8afjwSbjPs1HAF1wzYeUwGsaVx7fpNvzE4b/0ZwN1fBrefPGkht//MHwdFlWCWT4OdhSMj3YQGm5zgwBYuIq4f/t2ePMHPTjmvR/enuPyfHj+btBiZF7K4e2XYSEDC1hAKy3c9Tj8movzey6541IoeD/Du5zepeWcKy5O5+k7

Ответы

200

Распознование прошло успешно. В теле ответа содержится описание результатов распознования:

Название Тип Формат Описание
passport object PassportRequisites Реквизиты паспорта, которые получилось распознать. Указывается, если тип распознаваемого документа "Паспорт"

Пример ответа

  HTTP 200
  Content-Type: Application/json
  {
    "passport" :
    {
       "name": "Анастасия",
       "surname": "Тарасова",
       "patronymic": "Константиновна",
       "dateBirth": "2018-01-01",
       "birthPlace": "Где то",
       "gender": "Female",
       "number": "123456",
       "series": "1111",
       "issueDate": "2018-12-12",
       "issuerCode": "123-123",
       "issuerName": "кем-то"
    }
  }

400

Ошибки валидации запроса. В теле ответа содержится описание ошибки Error. Для данного метода возможны следующие ошибки:

Код ошибки Описание
UndefinedContent Не удалось найти загружаемый контент

Пример ответа

  HTTP 400
  Content-Type Application/json
  {
      "code": "validation",
      "message": "Failed to validate request",
      "target": "api",
      "errors":
      [
        {
          "code": "UndefinedContent",
          "message": "Can't find uploaded content",
          "target": "DriveApi"
        }
      ]
  }

401

Ошибка авторизации: пользователь не авторизован

403

Ошибка аутентификации: пользователь не имеет доступа к ресурсам организации, которая указана в заголовке авторизации

415

В заголовке Content-Type указан тип контента, который не поддерживается для данного метода