Recognise

Назначение

Метод recognise распознает документ по изображению и возвращает структурированные данные: тип документа, страну, версию и массив распознанных полей.

Метод не выполняет антифрод-проверки документа. Он отвечает только за извлечение данных из изображения.

Эндпоинт

Боевой контур:

POST https://api.mts.ru/ID-KYC-DOC-Recognition-Prod/2.0/api/v2/document-recognition/recognise

Полный URL может содержать query-параметры:

POST https://api.mts.ru/ID-KYC-DOC-Recognition-Prod/2.0/api/v2/document-recognition/recognise?type={Тип документа}&country={Страна документа}

Метод и протокол

Параметр	Значение
Метод	`POST`
Протокол	`HTTPS`
Тип тела запроса	Binary
Типовой `Content-Type`	`image/jpeg`, `image/png`, `image/tiff`

Авторизация

Authorization: Bearer <JWT>

Query-параметры

Параметр	Описание	Где	Тип	Обязательность
`type`	Тип документа	query	string	нет
`country`	Страна документа	query	string	нет

country передается трехбуквенным кодом ISO 3166-1 alpha-3, например rus.

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

Пример запроса

curl -X POST 
  -H "Authorization: Bearer <Ваш токен>" 
  -H "Content-Type: image/jpeg" 
  --data-binary "@/path/to/document.jpg" 
  "https://api.mts.ru/ID-KYC-DOC-Recognition-Prod/2.0/api/v2/document-recognition/recognise?type=passport&country=rus"

Ответ

В ответе возвращаются:

documentType – тип, страна и версия документа;
textFields – массив распознанных полей;
confidenceFlag – признак уверенности по каждому полю;
confidence – числовое значение уверенности, если оно включено для клиента.

Подробно структура ответа описана в разделе Формат ответа.

Ошибки

Если на изображении нет документа или документ не удалось распознать, сервис возвращает бизнес-ошибку DocumentNotRecognized.

Описание кодов см. в разделах: