MGBI надає комплексний API для отримання даних із державних реєстрів та облікових баз, зокрема з Національного реєстру боржників (KRZ).
Перелік джерел даних, доступних у цій службі, можна знайти на сторінці:
👉 API публічних реєстрів
Цей посібник стосується API для пошуку суб’єктів у Національному реєстрі боржників (KRZ), який ми надаємо в рамках продукту:
👉 API Національного реєстру боржників (KRZ API) — Пошук суб’єктів
Нижче ми описали, як за допомогою API можна завантажити перелік судових справ із Реєстру судових справ (KRZ) щодо вказаного боржника на підставі його податкового номера (NIP) або ідентифікаційного номера (PESEL).
Крок 1: Отримати ключ авторизації в API
Щоб отримати ключ авторизації, необхідний для виклику кінцевих точок, доступних в MGBI API, зв’яжіться з нами за допомогою контактної форми на сторінці продукту:
👉 API Національного реєстру боржників (KRZ API) — Пошукова система суб’єктів господарювання
Крок 2: Викличте кінцеву точку Create Refresh
Дані, доступні в Пошуковій системі суб’єктів KRZ, ми надаємо в MGBI API у вигляді моделі даних з ідентифікатором pl-krz-wp-record.
Ця модель синхронізується за запитом, що означає, що в наших базах даних ми не маємо повної копії даних, доступних у вихідному реєстрі.
Щоб отримати з моделі актуальні дані щодо вказаного боржника, спочатку потрібно створити запит на їх завантаження з KRZ за допомогою ендпойнту Create Refresh.
👉 Документація ендпойнту Create Refresh
Приклад виклику ендпойнту Create Refresh з номером NIP:
POST /v1/refresh HTTP/1.1
Host: api.mgbi.pl
Authorization: [klucz autoryzacji]
{
"query: {
"model": "pl-krz-wp-record",
"identifiers.pl_nip": [numer NIP]
}
}
Якщо вам потрібна інформація про провадження щодо боржника, який є фізичною особою, ви також можете скористатися номером PESEL.
Приклад виклику ендпойнту Create Refresh з номером PESEL:
POST /v1/refresh HTTP/1.1
Host: api.mgbi.pl
Authorization: [klucz autoryzacji]
{
"query: {
"model": "pl-krz-wp-record",
"identifiers.pl_nip": [numer NIP]
}
}
При правильному виклику кінцевої точки Create Refresh у відповідь повертається словник, що містить ідентифікатор запиту в полі id.
Крок 3: Викличте кінцеву точку Get Refresh
Запити на отримання даних із вихідного реєстру зазвичай виконуються протягом від кількох до кількох десятків секунд з моменту їх створення кінцевою точкою Create Refresh.
Щоб перевірити поточний статус замовлення, викличте ендпоінт Get Refresh, вказавши в URL-адресі його ідентифікатор, отриманий на попередньому кроці.
👉 Документація ендпоінту Get Refresh
Приклад виклику кінцевої точки Get Refresh із ідентифікатором запиту:
GET /v1/refresh/[ідентифікатор запиту] HTTP/1.1
Host: api.mgbi.pl
Authorization: [ключ авторизації]
Якщо у повернутому словнику поле status має значення pending, запит ще виконується, і через кілька секунд слід знову викликати кінцеву точку Get Refresh.
Якщо поле «статус» має значення «success», це означає, що запит виконано, а дані щодо вказаного боржника вже отримано з вихідного реєстру.
Крок 4: Викличте кінцеву точку Get Records
API для моделі pl-krz-wp-record надає кінцеву точку Get Records, яка повертає записи з повним текстом відповіді з Пошукової системи суб’єктів KRZ щодо вказаного боржника.
👉 Документація кінцевої точки Get Records для моделі pl-krz-wp-record
Щоб отримати дані, витягнуті з вихідного реєстру у раніше створеному запиті, викличте кінцеву точку Get Records, передавши ідентифікатор запиту в параметрі refresh_id.
Приклад виклику ендпойнту Get Records з ідентифікатором запиту:
GET /v1/models/pl-krz-wp-record/records?refresh_id=[ідентифікатор запиту] HTTP/1.1
Host: api.mgbi.pl
Authorization: [ключ авторизації]
Крок 5: З’ясуйте з відповіді перелік проваджень, що ведуться стосовно боржника
Правильний виклик ендпойнту Get Records повертає у відповідь список записів, що відповідають заданим критеріям. У наведеному вище прикладі ендпойнт повинен повернути список результатів, що містить один запис:
{
"count": 1,
"pages": 1,
"results": [
{
"id": [identyfikator rekordu],
"identifiers": [identyfikatory dłużnika],
"content": [treść odpowiedzi z wyszukiwarki],
"meta": [metadane rekordu]
}
]
}
Судові справи в Національному реєстрі боржників об’єднуються у так звані справи. Окрема справа може містити дані про одну або декілька пов’язаних між собою справ.
Залежно від організаційно-правової форми боржника, перелік справ можна знайти у полі:
- content.raw_result.wyszukaj-po-podmiocie.lista_uczestnikow.0.teczki — для суб’єктів, які не є фізичними особами,
- content.raw_result.wyszukaj-po-of-jdg.lista_uczestnikow.0.teczki — для фізичних осіб, які здійснюють господарську діяльність,
- content.raw_result.wyszukaj-po-of.lista_uczestnikow.0.teczki — для фізичних осіб, які не ведуть господарську діяльність.
Щоб переглянути повний перелік усіх проваджень щодо боржника, які оприлюднено в Реєстрі судових справ (KRZ), необхідно обробити кожну позицію переліку проваджень у кожній справі.
Приклад вмісту елемента списку «процедура»:
{
"aktualna-metryka": [dane dłużnika],
"dataRozpoczecia": [data rozpoczęcia postępowania],
"dataUtworzenia": [data utworzenia postępowania],
"dataZakonczenia": [data zakończenia postępowania],
"id": [identyfikator wewnętrzny postępowania],
"idZewnetrzny": [identyfikator zewnętrzny postępowania],
"rodzajPostepowania": [informacje o rodzaju postępowania],
"stanPostepowaniaRejestr": [aktualny stan postępowania],
"sygnaturaAkt": [sygnatura postępowania],
"szczegoly": [szczegółowe informacje o postępowaniu],
"szczegoly-UPE": [szczegółowe informacje o umorzonym postępowaniu egzekucyjnym]
}
Дізнайтеся більше:
👉 Структура даних у моделі pl-krz-wp-record
👉 Документація щодо кінцевих точок для моделі pl-krz-wp-record
