# Подписи и печати

{% hint style="success" %}
Чтобы воспользоваться сервисом, отправьте POST-запрос на URL `https://latest.dbrain.io/check/sign_seal`
{% endhint %}

{% hint style="info" %}
Перед началом работы с сервисами изучите раздел [«Общая информация о сервисах»](https://docs.dbrain.io/obshaya-informaciya/readme). Там мы рассказываем про допустимые форматы файлов, виды запросов и ответов, набор HTTP-статусов и даём рекомендации по устранению ошибок
{% endhint %}

## Параметры запроса к API

{% hint style="success" %}
**Асинхронный запрос**

<mark style="color:green;">**async**</mark> — boolean

Поведение по умолчанию: `async=false` — сервис обрабатывает запросы синхронно. При отправке запроса вы получите ответ только после окончательного завершения обработки запроса сервисом.

Если вам нужен асинхронный режим, укажите в запросе `async=true`. В ответ на запрос сервис вернёт в `response body` параметр `task_id`. Например:

```json
"task_id": "96b8ccc950a70699927036842c624d7c"
```

Используйте этот `task_id`, чтобы получить результат работы сервиса в методе `result`:

```bash
curl -X 'GET' \
  'https://latest.dbrain.io/result/96b8ccc950a70699927036842c624d7c?token=XXX' \
  -H 'accept: application/json'
```

Не забудьте указать в параметре `token` ваш ключ лицензии. Рекомендуем запрашивать метод `result` в цикле с периодом 1-2 секунды
{% endhint %}

{% hint style="success" %}
**Возврат найденных областей изображения**

<mark style="color:green;">**return\_crops**</mark> — boolean

* true — сервис вернёт в ответе API найденные области изображения с печатями и подписями
* false (по умолчанию) —  cервис не вернёт найденные области изображения

<mark style="color:red;">Ответ приходит в объект images массива result</mark>
{% endhint %}

{% hint style="success" %}
**Тегирование запроса**

<mark style="color:green;">**task\_tags**</mark> — string array

Поведение по умолчанию: параметр не используется.

Функция тегирует запросы по вашему усмотрению. Это упрощает отслеживание пакетов документов, связанных с конкретным клиентом-физлицом. Для использования функции укажите в параметре `task_tags` удобный вам тег: `task_tags=тэг`
{% endhint %}

## Тело запроса к API

{% hint style="success" %}
**Изображение**

<mark style="color:green;">**image**</mark> — string ($binary)

Изображение обязательно для передачи в запросе. Сервис ожидает изображение документа в двоичном виде
{% endhint %}

## В ответе на запрос к API:

<table data-header-hidden data-full-width="true"><thead><tr><th width="232">Название</th><th width="136.33333333333331">Тип</th><th>Описание</th></tr></thead><tbody><tr><td>task_id</td><td>string</td><td>Идентификатор запроса, формат: 32 символа, 16-ричная строка</td></tr><tr><td>error</td><td>string</td><td>Текстовое описание ошибки</td></tr><tr><td>task_tags</td><td>array[string]</td><td>Теги, если они переданы в параметре task_tags</td></tr><tr><td>success</td><td>boolean</td><td>Статус запроса</td></tr><tr><td>status_code</td><td>integer</td><td><p>HTTP-код статуса запроса</p><ul><li>200 — запрос выполнен успешно</li><li>400, 403, 500 и т.д. — расшифрованы в «<a href="../../../obshaya-informaciya/readme#http-kody-otveta-na-zapros">Общей информации о сервисах</a>»</li></ul></td></tr><tr><td>result.images</td><td>array[$string]</td><td><a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs">data URL</a> с MIME-типом JPEG в формате base64 — найденные области изображения с печатями и подписями. Возвращается, если в запросе передать <code>return_crops=true</code></td></tr><tr><td>result.doc_type</td><td>string</td><td>Всегда возвращается пустым. Оставлен для совместимости структуры ответа с другими методами API</td></tr><tr><td>result.confidence</td><td>number</td><td>Всегда равно 1. Оставлен для совместимости структуры ответа с другими методами API</td></tr><tr><td>result.page_num</td><td>integer</td><td>Номер страницы в оригинальном файле, на котором найдены подписи и печати</td></tr><tr><td>result.fields</td><td>array</td><td>Массив, содержащий найденные подписи и печати</td></tr><tr><td>result.fields.name</td><td>string</td><td>Тип и порядковый номер найденной области изображения. Для печатей это print_X, для подписей это signature_X, где X — порядковый номер</td></tr><tr><td>result.fields.value</td><td>string</td><td>Всегда возвращает «true». Оставлен для совместимости структуры ответа с другими методами API</td></tr><tr><td>result.fields.confidence</td><td>number</td><td>Уровень уверенности сервиса от 0 до 1 в корректности детекции печати или подписи</td></tr><tr><td>result.fields.page_num</td><td>integer</td><td>Номер страницы в оригинальном файле, на котором найдена печать или подпись</td></tr><tr><td>result.fields.coords</td><td>array[integer]</td><td>Массив с координатами поля по четырём точкам: верхний левый угол, верхний правый, нижний левый, нижний правый. Поле может состоять из нескольких частей</td></tr><tr><td>result.fields.crops</td><td>array[$string]</td><td>Массив <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs">data URL</a> с MIME-типом JPEG в формате base64 — изображения найденных областей изображения с печатью или подписью. Возвращается, если в запросе передать <code>return_crops=true</code></td></tr><tr><td>result.fields.is_found</td><td>boolean</td><td><ul><li>true — поле найдено в документе</li><li>false — поле в документе не найдено</li></ul></td></tr><tr><td>result.tables</td><td>array[array]]</td><td>Всегда возвращает пустой массив. Оставлен для совместимости структуры ответа с другими методами API</td></tr></tbody></table>
