MGBI dostarcza kompleksowe API do pobierania danych z rejestrów i ewidencji publicznych, w tym z Krajowego Rejestru Zadłużonych (KRZ).
Listę źródeł danych dostępnych w tej usłudze znajdziesz na stronie:
👉 Rejestry Publiczne API
Ten poradnik dotyczy API dla wyszukiwarki podmiotów KRZ, który udostępniamy w ramach produktu:
👉 Krajowy Rejestr Zadłużonych API (KRZ API) - Wyszukiwarka Podmiotów
Poniżej opisaliśmy, w jaki sposób możesz pobrać przez API listę postępowań sądowych z KRZ dla wskazanego dłużnika na podstawie jego numeru NIP lub PESEL.
Krok 1: Uzyskaj klucz autoryzacji w API
Aby zdobyć klucz autoryzacji wymagany przy wywoływaniu endpointów dostępnych w MGBI API, skontaktuj się z nami przy użyciu formularza kontaktowego na stronie produktu:
👉 Krajowy Rejestr Zadłużonych API (KRZ API) - Wyszukiwarka Podmiotów
Krok 2: Wywołaj endpoint Create Refresh
Dane dostępne w Wyszukiwarce Podmiotów KRZ udostępniamy w MGBI API w modelu danych o identyfikatorze pl-krz-wp-record.
Model ten jest synchronizowany na żądanie, co oznacza, że nie dysponujemy dla niego w naszych zbiorach pełną kopią danych dostępnych w rejestrze źródłowym.
Aby uzyskać z modelu aktualne dane dotyczące wskazanego dłużnika, musisz najpierw utworzyć zlecenie ich pobrania z KRZ przy użyciu endpointu Create Refresh.
Przykład wywołania endpointu Create Refresh z numerem 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]
}
}
Jeśli potrzebujesz informacji o postępowaniach prowadzonych wobec dłużnika będącego osobą fizyczną, możesz również użyć numeru PESEL.
Przykład wywołania endpointu Create Refresh z numerem 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]
}
}
Prawidłowe wywołanie endpointu Create Refresh zwraca w odpowiedzi słownik zawierający identyfikator zlecenia w polu id.
Krok 3: Wywołaj endpoint Get Refresh
Zlecenia pobrania danych z rejestru źródłowego zwykle trwają od kilku do kilkunastu sekund od momentu ich utworzenia endpointem Create Refresh.
Aby sprawdzić aktualny status zlecenia, wywołaj endpoint Get Refresh podając w adresie URL jego identyfikator uzyskany w poprzednim kroku.
Przykład wywołania endpointu Get Refresh z identyfikatorem zlecenia:
GET /v1/refresh/[identyfikator zlecenia] HTTP/1.1
Host: api.mgbi.pl
Authorization: [klucz autoryzacji]
Jeśli w zwróconym słowniku pole status przyjmuje wartość pending, zlecenie jest jeszcze w trakcie wykonywania i należy ponownie wywołać endpoint Get Refresh za kilka sekund.
Jeśli pole status przyjmuje wartość success, to oznacza, że zlecenie zostało wykonane i dane dotyczące wskazanego dłużnika zostały już pobrane z rejestru źródłowego.
Krok 4: Wywołaj endpoint Get Records
API dla modelu pl-krz-wp-record udostępnia endpoint Get Records, który zwraca rekordy z pełną treścią odpowiedzi z Wyszukiwarki Podmiotów KRZ dla wskazanego dłużnika.
👉 Dokumentacja endpointu Get Records dla modelu pl-krz-wp-record
Aby otrzymać dane pobrane z rejestru źródłowego w utworzonym wcześniej zleceniu, wywołaj endpoint Get Records przekazując identyfikator zlecenia w parametrze refresh_id.
Przykład wywołania endpointu Get Records z identyfikatorem zlecenia:
GET /v1/models/pl-krz-wp-record/records?refresh_id=[identyfikator zlecenia] HTTP/1.1
Host: api.mgbi.pl
Authorization: [klucz autoryzacji]
Krok 5: Odczytaj z odpowiedzi listę postępowań prowadzonych wobec dłużnika
Prawidłowe wywołanie endpointu Get Records zwraca w odpowiedzi listę rekordów spełniających podane kryteria. W powyższym przykładzie endpoint powinien zwrócić listę wyników zawierającą jeden rekord:
{
"count": 1,
"pages": 1,
"results": [
{
"id": [identyfikator rekordu],
"identifiers": [identyfikatory dłużnika],
"content": [treść odpowiedzi z wyszukiwarki],
"meta": [metadane rekordu]
}
]
}
Postępowania sądowe w Krajowym Rejestrze Zadłużonych są grupowane w tzw. teczki. Pojedyncza teczka może zawierać dane jednego lub większej liczby powiązanych ze sobą postępowań.
W zależności od formy prawnej dłużnika listę teczek znajdziesz w polu:
- content.raw_result.wyszukaj-po-podmiocie.lista_uczestnikow.0.teczki - dla podmiotów niebędących osobami fizycznymi,
- content.raw_result.wyszukaj-po-of-jdg.lista_uczestnikow.0.teczki - dla osób fizycznych prowadzących działalność gospodarczą,
- content.raw_result.wyszukaj-po-of.lista_uczestnikow.0.teczki - dla osób fizycznych nieprowadzących działalności gospodarczej.
Odczytanie pełnej listy wszystkich postępowań prowadzonych wobec dłużnika i ujawnionych w KRZ wymaga przetworzenia każdego elementu listy postepowanie w każdej z teczek.
Przykładowa zawartość elementu listy postepowanie:
{
"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]
}
Uzyskaj więcej informacji:
👉 Struktura danych w modelu pl-krz-wp-record
👉 Dokumentacja endpointów dla modelu pl-krz-wp-record
