> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fin-observe.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Параметри запиту

> Дані необхідні для формування запиту

## Сервера API

* checklists.fin-observe.com
* res1-checklists.fin-observe.com
* res2-checklists.fin-observe.com

## Тип запиту

* [GET](/uk/check-lists/checklists-get)
* [POST](/uk/check-lists/checklists-post)

## Вхідні параметри

### Обов'язкові

<ParamField query="IDsubjectFM" body="IDsubjectFM" type="string" required>
  ID суб’єкта ФМ (присвоюється при реєстрації суб’єкта ФМ в ПК “FinAP CheckLists”). Приходить на електронну пошту відповідальної особи
</ParamField>

<ParamField query="tokken" body="tokken" type="string" required>
  Унікальний ключ користувача суб’єкта ФМ (надається при реєстрації суб’єкта ФМ в ПК “FinAP CheckLists”). Приходить на електронну пошту відповідальної особи
</ParamField>

### Основні

<ParamField query="name" body="name" type="string">
  Прізвище, ім’я, по-батькові або назва особи
</ParamField>

<ParamField query="ipn" body="ipn" type="string">
  Індивідуальний податковий номер фізичної особи - резидента (більшість реєстрів не містять даних про РНОКПП), або ЄДРПОУ юридичної особи резидента
</ParamField>

<ParamField query="date" body="date" type="date" placeholder="YYYY-MM-DD">
  Дата народження фізичної особи у форматі “YYYY-MM-DD”
</ParamField>

<ParamField query="doc" body="doc" type="string">
  Реквізити документа фізичної особи (національний пасторт, ID картка або паспорт для виїзду за кордон) у форматі серія і номер, або просто номер (якщо ID карта). Наявність або відсутність пробілу між серією і номером значення не має
</ParamField>

### Додаткові

<ParamField query="IDinternal" body="IDinternal" type="string">
  Внутрішній унікальний ID запиту (генерується на стороні суб’єкта ФМ)
</ParamField>

<ParamField query="DateRequest" body="DateRequest" type="datetime">
  Дата та час формування запиту (генерується на стороні суб’єкта ФМ) у форматі “YYYY-MM-DD hh:mm:ss”
</ParamField>

<ParamField query="IDuserPC" body="IDuserPC" type="string">
  ID робочого місця суб’єкта ФМ (присвоюється на стороні суб’єкта ФМ)
</ParamField>

<ParamField query="listdata" body="listdata" default="-1" type="numeric">
  Число, кожен біт якого при переведенні у двійковий формат визначає перелік баз (списків) у яких має здійснюватися пошук (або сума чисел, які відповідають пошуковим спискам). Нариклад, для пошуку у діючих санкційних списках “listdata” : 127 — “0000 0000 0000 0111 1111”. Див. Табл.2. За замовчуванням використовується значення яке відповідає запиту у всі реєстри сервісу
</ParamField>

<ParamField query="search" body="search" default="1" type="numeric">
  Метод пошуку збігів по реєстрам (1 — повнотекстний (за замовчуванням), 2 — з корекцією помилок). За замовчуванням – 1
</ParamField>

<ParamField query="lowranklimit" body="lowranklimit" default="0" type="numeric">
  Число, що визначає нижню межу співпадінь назви чи ПІБ у відсотках
</ParamField>

<ParamField query="namelat" body="namelat" type="string">
  Прізвище, ім’я, по-батькові або назва у латиниці. За замовчуванням генерується із поля name за результатами роботи алгоритму транслітерації
</ParamField>

<ParamField query="nonrezedentcode" body="nonrezedentcode" type="string">
  Код нерезедента
</ParamField>

<ParamField query="city" body="city" type="string">
  Назва населеного пункту. Використовується для пошуку підприємців в Реєстр юридичних осіб та ФОП за місцем приписки, а також в реєстрі податкових боржників за приналежністю податкової
</ParamField>

<ParamField query="doctype" body="doctype" default="0" type="numeric">
  Тип документу. Може приймати значення 1 (ПАСПОРТ ГРОМАДЯНИНА УКРАЇНИ в тому числі і ID карти), 2 (ПАСПОРТ ГРОМАДЯНИНА УКРАЇНИ ДЛЯ ВИЇЗДУ ЗА КОРДОН), 0 – обидва варіанти. За замовчуванням – 0
</ParamField>

<ParamField query="edrchangesfrom" body="edrchangesfrom" default="1991-08-24" type="date">
  Дата початку періоду змін в ЄДР (для Аналізу) у форматі “YYYY-MM-DD”
</ParamField>

<ParamField query="edrchangesto" body="edrchangesto" default="now()" type="date">
  Дата закінчення періоду змін в ЄДР (для Аналізу) у форматі “YYYY-MM-DD”
</ParamField>

<ParamField query="arrayedrpou" body="arrayedrpou" type="string[]">
  Перелік (масив) кодів ЄДРПОУ, щодо яких аналізуються зміни в ЄДР протягом заданого періоду
</ParamField>

<ParamField query="onlyactual" body="onlyactual" default="true" type="boolean">
  Даний параметр вказує чи повертати актуальний запис чи всі нявні в реєстрі записи (true – актуальний, false - всі). За замовчуванням – актуальний.
</ParamField>
