Skip to main content
POST
CheckLists POST

Тіло

application/json
tokken
string
обов'язково

Унікальний ключ користувача суб’єкта ФМ (надається при реєстрації суб’єкта ФМ в ПК 'FinAP CheckLists'). Приходить на електронну пошту відповідальної особи

IDsubjectFM
string
обов'язково

ID суб’єкта ФМ (присвоюється при реєстрації суб’єкта ФМ в ПК 'FinAP CheckLists'). Приходить на електронну пошту відповідальної особи

listdata
number

Число, кожен біт якого при переведенні у двійковий формат визначає перелік баз (списків) у яких має здійснюватися пошук (або сума чисел, які відповідають пошуковим спискам).

name
string

Прізвище, ім'я, по-батькові або назва

namelat
string

Прізвище, ім'я, по-батькові або назва у латиниці. За замовчуванням генерується із поля name за результатами роботи алгоритму транслітерації

ipn
string

Індивідуальний податковий номер фізичної особи - резидента (більшість реєстрів не містять даних про РНОКПП), або ЄДРПОУ юридичної особи резидента

date
date

Дата народження фізичної особи у форматі “YYYY-MM-DD”

doc
string

Реквізити документа фізичної особи (національний пасторт, ID картка або паспорт для виїзду за кордон) у форматі серія і номер, або просто номер (якщо ID карта). Наявність або відсутність пробілу між серією і номером значення не має.

doctype
number

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

Метод пошуку збігів по реєстрам (1 — повнотекстний (за замовчуванням), 2 — з корекцією помилок). За замовчуванням – 1

lowranklimit
number

Число, що визначає нижню межу співпадінь назви чи ПІБ у відсотках

Відповідь

Успішна відповідь

Схема відповіді на запит до сервісу CheckLists

idinternal
string

Внутрішній унікальний ID запиту,що генерується засобами внутрішнього програмного забезпечення суб'єкта ФМ

idsubjectFM
string

ID cуб'єкта ФМ (просвоюється при реєстрації суб'єкта ФМ в ПК 'FinAP CheckLists')

iduserPC
string

ID робочого місця cуб'єкта ФМ (просвоюється на стороні суб'єкта ФМ)

idrequest
string

Ідентифікатор запиту в системі ПК 'FinAP CheckLists' (генерується засобами Сервісу обробки запитів)

dateResponse
string

Дата та час формування відповіді (генерується засобами Сервісу обробки запитів) у форматі 'YYYY-MM-DD hh:mm:ss'

listdata
string

Число, яке при приведенні у двійковий формат відображає у яких списках даних був здійснений пошук збігів

Метод пошуку (1 — повнотекстний, 2 — контекстний...)

responsetype
string

Тип відповіді (результату запиту): 1 — відповідь-дозвіл (true|false); 2 – узагальнений; 3 — скорочений; 5 — повний;

textformat
string

Формат текстового поля для повного типу відповіді (responsetype=5), може набувати значення 'JSON' (або ' ', за замовчуванням), 'xml', 'html' і 'text'

result
Блок відповіді з реєстрів · object

Блок результатів обробки запит в реєстри CheckLists