Відкритий API

З 31 грудня 2020 року модернізований Реєстр декларацій впроваджено в постійну експлуатацію. 
Дані про подані декларації доступні у машинозчитуваному форматі JSON.

Оновлення відкритого АРІ:

  • Дані кроків замість масивів ['data']['step_<0..16>'] знаходяться у масивах ['data']['step_<0..17>']['data'];
  • Поле ['lastmodified_date'] перейменовано у ['date'];
  • Поле ['created_date'] вилучено;
  • Дані з кроку 2.1 декларації (['postType'], ['postCategory'], ['responsiblePosition'], ['corruptionAffected']) продубльовано на верхньому рівні у відповідних полях: ['responsible_position'], ['post_type'], ['post_category'] (порядковий номер з довідника), ['corruption_affected'];
  • Дані з кроку 1 ['declarationType'] продубльовано на верхньому рівні у полі ['declaration_type'];
  • У полі ['declaration_year'] зазначено звітній період декларації.

Отримання конкретного документа

Приклад запиту: https://public-api.nazk.gov.ua/v2/documents/210f5cfe-d5e9-4af8-8b6c-226b2eba6819

де 210f5cfe-d5e9-4af8-8b6c-226b2eba6819 – унікальний ідентифікатор документа {document_id}.

  • При запиті неіснуючого документа буде повернуто JSON {error: 1310002}.
  • При запиті неіснуючої сторінки буде повернуто JSON {error: 404}.

Фільтрація та пошук документів

Наявна можливість фільтрації та пошуку, використовуючи необов’язкові GET-параметри.

Приклад запиту: https://public-api.nazk.gov.ua/v2/documents/list?query=Прізвище&user_declarant_id=3000099

Список необов’язкових GET-параметрів:

  • query — поле "Пошуковий запит", текстове, від 3 до 255 символів. При невідповідності довжини повертає помилку JSON {error: 1310101}. При існуванні цього поля сортування буде йти по релевантності, а не по даті подання.
  • full_search — маркер "Шукати скрізь", числове/булеве (1 або 0). Використовується разом із параметром query для увімкнення повнотекстового пошуку за всіма текстовими полями документа, а не лише за ПІБ.
    Приклад запиту: https://public-api.nazk.gov.ua/v2/documents/list?query=НАЗК&full_search=1
  • user_declarant_id — поле "ID суб’єкта декларування", числове, від 1 до 10000000. При невідповідності заповнення повертає помилку JSON {error: 1310111} або JSON {error: 1310112}.
  • document_type — поле "Тип документа", числове, від 1 до 3. При невідповідності заповнення повертає помилку JSON {error: 1310121} або JSON {error: 1310122}.
  • declaration_type — поле "Тип декларації", числове, від 1 до 4. При невідповідності заповнення повертає помилку JSON {error: 1310131} або JSON {error: 1310132}.
  • declaration_year — поле "Рік декларації", числове, від 2015 до поточного року. При невідповідності заповнення повертає помилку JSON {error: 1310141} або JSON {error: 1310142}.
  • start_date — поле "Початок дати подання", числове, від 1470009600 (01.08.2016) до поточної дати у секундах від початку епохи UNIX. При невідповідності заповнення повертає помилку JSON {error: 1310151} або JSON {error: 1310152}.
  • end_date — поле "Кінець дати подання", числове, від 1470009600 (01.08.2016) до поточної дати у секундах від початку епохи UNIX. При невідповідності заповнення повертає помилку JSON {error: 1310161} або JSON {error: 1310162}.
  • page — поле "№ сторінки" для пересування по сторінках, якщо кількість результатів перевищує 100, числове, від 1 до 100. При невідповідності заповнення повертає помилку JSON {error: 1310171} або JSON {error: 1310172}.

Параметри фільтрації за місцем роботи:

Параметри фільтрації за адресою (код КАТОТТГ):

Формат коду КАТОТТГ: Для фільтрації використовується повний ієрархічний шлях коду КАТОТТГ, де рівні розділені крапкою (наприклад, 1.UA[код_області].UA[код_району]).

Зареєстроване місце проживання:

Місце фактичного проживання:

Довідники

Доступний запит для отримання довідника країн, які можуть бути у поданих документах: https://public-api.nazk.gov.ua/v2/countries/list