# Метаданные

## Обзор

При создании какого-либо [объекта системы](https://doc.ozforensics.com/oz-knowledge-ru/rukovodstva/rukovodstvo-razrabotchika/api/oz-api/obekty-sistemy) у вас может возникнуть необходимость хранить для него дополнительные данные, те, которые отсутствуют в базовом списке его параметров. Такие данные называются метаданными. Вы можете хранить любую нужную вам информацию в разделе `meta_data` в приведенном ниже формате ("название поля": "соответствующие полю данные"):

```json
…
meta_data:
{
  "field1": "value1",
  "field2": "value2"
}
…
```

## Объекты и методы

Метаданные можно добавить к большинству объектов системы. Список объектов с соответствующими им методами для добавления метаданных приведен ниже. Также метаданные можно указать при создании объекта.

| **Объект**     | **Метод API**                                                                                                                                                                                                     |
| -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Пользователь   | `PATCH /api/users/{{user_id}}`                                                                                                                                                                                    |
| Папка (заявка) | `PATCH /api/folders/{{folder_id}}/meta_data/`                                                                                                                                                                     |
| Медиафайл      | `PATCH /api/media/{{media_id}}/meta_data`                                                                                                                                                                         |
| Анализ         | `PATCH /api/analyses/{{analyse_id}}/meta_data`                                                                                                                                                                    |
| Коллекция      | <p><code>PATCH /api/collections/{{collection\_id}}/meta\_data/</code></p><p>and, for a person in a collection,</p><p><code>PATCH /api/collections/{{collection\_id}}/persons/{{person\_id}}/meta\_data</code></p> |

Метаданные можно также и менять, и удалять. Все нужные методы описаны в нашей [документации по API.](https://apidoc.ozforensics.com/)

## Примеры использования

Метаданные могут вам потребоваться, например, если вы захотите группировать папки (заявки) по людям или лидам. Например, для подсчета конверсии в случаях, когда один лид делает несколько попыток пройти анализ Liveness, добавьте идентификатор этого лида в метаданные соответствующих папок.

Чтобы добавить идентификатор клиента `iin` к объекту папки, в тело запроса внесите соответствующую запись:

```json
{
  "iin": "123123123"
}
```

{% hint style="info" %}
Вы можете передать в это поле идентификатор клиента и затем использовать его для получения запросов по одному и тому же клиенту или подсчета уникальных клиентов (одинаковый идентификатор = один и тот же клиент, разные идентификаторы = разные клиенты). Идентификатор может быть номером телефона, документа или любым другим уникальным идентификатором. Идентификатор будет отображаться в отчете отдельной колонкой.
{% endhint %}

Еще один частый случай использования метаданных связан с безопасностью: вы обрабатываете результат анализа на своем бэкенде, но не хотите при этом использовать идентификатор папки при обращении к ней. Добавьте отдельный идентификатор (`transaction_id`) в метаданные папки, и вы сможете искать нужную информацию по нему. Подробно этот случай использования описан [здесь](https://doc.ozforensics.com/oz-knowledge-ru/rukovodstva/rukovodstvo-razrabotchika/sdk/websdk/web-plugin/rekomendacii-po-bezopasnosti).

Если вы храните в метаданных персональные данные, убедитесь, что при этом не нарушаются соответствующие законы.

Метаданные можно также добавить через SDK, а затем работать с ними с помощью методов API. Добавление метаданных через SDK описано в соответствующих разделах:

* [iOS](https://doc.ozforensics.com/oz-knowledge-ru/rukovodstva/sdk/oz-mobile-sdk/ios/vypolnenie-proverok#dobavlenie-metadannykh)
* [Android](https://doc.ozforensics.com/oz-knowledge-ru/rukovodstva/sdk/oz-mobile-sdk/android/vypolnenie-proverok#dobavlenie-metadannykh)
* [Web](https://doc.ozforensics.com/oz-knowledge-ru/rukovodstva/rukovodstvo-razrabotchika/sdk/websdk/web-plugin/zapusk-plagina)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://doc.ozforensics.com/oz-knowledge-ru/rukovodstva/rukovodstvo-razrabotchika/api/oz-api/metadata.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.