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

# Parametry wejściowe

> Параметри API-запиту (перелік пар назва/значення у первинному запиті):

|      Назва      | Тип значення |                                                                                                                                                                             Опис пари “назва/значення”                                                                                                                                                                             |                  Особливості застосування                  |
| :-------------: | :----------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------: |
|    IDinternal   |    numeric   |                                                                                                                                                        Внутрішній унікальний ID запиту (генерується на стороні суб'єкта ФМ)                                                                                                                                                        |                                                            |
|   DateRequest   |   datetime   |                                                                                                                                         Дата та час формування запиту (генерується на стороні суб'єкта ФМ) у форматі “YYYY-MM-DD hh:mm:ss”                                                                                                                                         |                                                            |
|   IDsubjectFM   |   string \*  |                                                                                                                        ID суб’єкта ФМ (присвоюється при реєстрації суб’єкта ФМ в ПК “FinAP CheckLists"). Приходить на електронну пошту відповідальної особи.                                                                                                                       |                                                            |
|     IDuserPC    |    numeric   |                                                                                                                                                         ID робочого місця суб’єкта ФМ (присвоюється на стороні суб'єкта ФМ)                                                                                                                                                        |                                                            |
|      tokken     |   string\*   |                                                                                                             Унікальний ключ користувача суб’єкта ФМ (надається при реєстрації суб’єкта ФМ в ПК “FinAP CheckLists"). Приходить на електронну пошту відповідальної особи.                                                                                                            |                                                            |
|     listdata    |    numeric   | Число, кожен біт якого при переведенні у двійковий формат визначає перелік баз (списків) у яких має здійснюватися пошук (або сума чисел, які відповідають пошуковим спискам). Нариклад, для пошуку у діючих санкційних списках “listdata” : 127 — “0000 0000 0000 0111 1111”. Див. Табл.2. За замовчуванням використовується значення яке відповідає запиту у всі реєстри сервісу. |                                                            |
|      search     |    numeric   |                                                                                                                               Метод пошуку збігів по реєстрам (1 — повнотекстний (за замовчуванням), 2 — з корекцією помилок). За замовчуванням – 1.                                                                                                                               |                                                            |
|   lowranklimit  |    numeric   |                                                                                                                                                          Число, що визначає нижню межу співпадінь назви чи ПІБ у відсотках                                                                                                                                                         |                                                            |
|       name      |    string    |                                                                                                                                                                        Прізвище, ім'я, по-батькові або назва                                                                                                                                                                       |                                                            |
|     namelat     |    string    |                                                                                                                     Прізвище, ім'я, по-батькові або назва у латиниці. За замовчуванням генерується із поля name за результатами роботи алгоритму транслітерації                                                                                                                    |                                                            |
|       date      |     date     |                                                                                                                                                                Дата народження фізичної особи у форматі “YYYY-MM-DD”                                                                                                                                                               |                                                            |
|       ipn       |    string    |                                                                                                                  Індивідуальний податковий номер фізичної особи - резидента (більшість реєстрів не містять даних про РНОКПП), або ЄДРПОУ юридичної особи резидента                                                                                                                 |                                                            |
| nonrezedentcode |    string    |                                                                                                                                                                                   Код нерезедента                                                                                                                                                                                  |                                                            |
|       city      |    string    |                                                                                               Назва населеного пункту. Використовується для пошуку підприємців в Реєстр юридичних осіб та ФОП за місцем приписки, а також в реєстрі податкових боржників за приналежністю податкової.                                                                                              |                                                            |
|       doc       |    string    |                                                                      Реквізити документа фізичної особи (національний пасторт, ID картка або паспорт для виїзду за кордон) у форматі серія і номер, або просто номер (якщо ID карта). Наявність або відсутність пробілу між серією і номером значення не має.                                                                      | Реєстр "Викрадені, втрачені, недійсні документи" (lostdoc) |
|     doctype     |   smallint   |                                                                                           Тип документу. Може приймати значення 1 (ПАСПОРТ ГРОМАДЯНИНА УКРАЇНИ в тому числі і ID карти), 2 (ПАСПОРТ ГРОМАДЯНИНА УКРАЇНИ ДЛЯ ВИЇЗДУ ЗА КОРДОН), 0 – обидва варіанти. За замовчуванням – 0.                                                                                          | Реєстр "Викрадені, втрачені, недійсні документи" (lostdoc) |
|  edrchangesfrom |     date     |                                                                                                                                                        Дата початку періоду змін в ЄДР (для Аналізу) у форматі “YYYY-MM-DD”                                                                                                                                                        |      Реєстр “Зміни даних юридичних осіб” (edrchanges)      |
|   edrchangesto  |     date     |                                                                                                                                                       Дата закінчення періоду змін в ЄДР (для Аналізу) у форматі “YYYY-MM-DD”                                                                                                                                                      |      Реєстр “Зміни даних юридичних осіб” (edrchanges)      |
|   arrayedrpou   |   string\[]  |                                                                                                                                             Перелік (масив) кодів ЄДРПОУ, щодо яких аналізуються зміни в ЄДР протягом заданого періоду                                                                                                                                             |      Реєстр “Зміни даних юридичних осіб” (edrchanges)      |
|    onlyactual   |    boolean   |                                                                                                                 Даний параметр вказує чи повертати актуальний запис чи всі нявні в реєстрі записи (true – актуальний, false - всі). За замовчуванням – актуальний.                                                                                                                 |     Реєстр “Реєстр Юридичних осіб та ФОП” (edrfullinfo)    |

<Danger>
  \* - обов'язкові набори пар “назва/значення”
</Danger>